Obter um webhook

Retorna um único webhook pelo seu ID.

Authentication

AuthorizationBearer

API Key in the format mk_live_<43-chars>. Obtain from the Dashboard or POST /auth/api-keys.

Path parameters

idstringRequired
Unique identifier of the webhook

Response

Default Response
idstring
Unique identifier of the webhook
urlstring
HTTPS endpoint URL that receives webhook POST requests
eventslist of strings
List of event types this webhook is subscribed to
numberIdslist of strings
List of number IDs this webhook is filtered to. Empty array means all numbers.
contactslist of strings

List of contacts this webhook is restricted to. Empty array means all contacts (catch-all).

activeboolean
Whether the webhook is currently active. Automatically set to false after 10 consecutive delivery failures.
createdAtstring
ISO 8601 timestamp when the webhook was created
failureCountdouble

Number of consecutive delivery failures. Resets to 0 on a successful delivery. Webhook is auto-disabled at 10.

lastStatusCodedouble or null
HTTP status code returned by the endpoint on the most recent delivery attempt
lastTriggeredAtstring or null
ISO 8601 timestamp of the most recent delivery attempt
updatedAtstring
ISO 8601 timestamp when the webhook was last updated

Errors

401
Unauthorized Error
404
Not Found Error