Skip to navigation

Get webhook endpoint by ID

Retrieve details of a specific webhook endpoint by ID

Authentication

AuthorizationBearer

Bearer token authentication for Mercury API.

Use your API token in the Authorization header: Authorization: Bearer TOKEN

Example: Authorization: Bearer secret-token:mercury_production_wma_24SCp4G81X3yHL4Wq8FgzuaP9ye3VKf2mgTDctXyRg5HY_yrucrem

Your Mercury API token should include the ‘secret-token:’ prefix. Tokens can be generated from your Mercury dashboard settings.

Path parameters

webhookEndpointIdstringRequiredformat: "uuid"

Response

createdAtstringformat: "yyyy-mm-ddThh:MM:ssZ"
idstringformat: "uuid"
statusenum
The operational status of a webhook endpoint.
Allowed values:
updatedAtstringformat: "yyyy-mm-ddThh:MM:ssZ"
urlstring
The URL that will receive webhook POST requests
eventTypeslist of enums or nullOptional
Optional array of event types this webhook is subscribed to. Nothing means all events.
filterPathslist of enums or nullOptional
Optional array of resource field paths to filter events by. Nothing means no filtering.
secretstring or nullOptional

Webhook signing secret. Only returned on creation (POST), not on GET or UPDATE operations.

Errors

404
Not Found Error