GET/v1/properties/{propertyId}/webhooks
Returns the outgoing webhooks of a property. The API returns only the scheme and host of each webhook URL, because the path and the query string can contain secrets.
Before you call
Section titled “Before you call”This endpoint needs IDs that other endpoints return:
- Call List the account properties. Copy the
idof the property: it is thepropertyId. - Call this endpoint with these IDs.
Authentication
Section titled “Authentication”bearerAuth: API key created in the dashboard (atk_…). Send it in the Authorization: Bearer YOUR_API_KEY header.
Path parameters
Section titled “Path parameters”propertyIdstringrequiredID of the property. Get it from
listProperties (id).Responses
Section titled “Responses”Every response field is present unless it shows optional. A type that ends in | null can be null.
200 Successful response
Section titled “200 Successful response”application/json
dataarray of objectWebhooks of the property. This list has no pages.
Show 8 child attributes
idstringID of the webhook. Send it as
webhookId to Get a webhook.namestringName of the webhook.
urlOriginstring | nullScheme and host of the webhook URL, for example
https://example.com. The API does not return the path or the query string, because they can contain secrets. null when the saved URL has no valid HTTP(S) origin.eventNamesarray of stringAnyTrack events that the webhook sends.
versionintegerPayload version of the webhook.
Min
-9007199254740991Max 9007199254740991enabledbooleanfalse when a user turned off the webhook.healthybooleanfalse when AnyTrack marks the webhook as unhealthy.crossDomainPropertyIdstring | nullID of the cross-domain property that filters the events of this webhook.
null when the webhook has no cross-domain filter.Errors
Section titled “Errors”Every error returns the error object.
| Status | Description and action |
|---|---|
400 | invalid_request, invalid_cursor: A parameter or a body field is not valid, or the cursor belongs to a different query. Correct the request. error.details, when present, names invalid fields. Do not reuse a cursor with a different query. |
401 | unauthenticated: Missing, invalid or deleted API key. Send a valid key in Authorization: Bearer. MCP uses an OAuth access token, which may also expire or be revoked. |
403 | api_access_unavailable: API access is disabled for this account. Contact AnyTrack support. OAuth requests also require the anytrack:read scope (insufficient_scope). |
404 | not_found: An ID does not exist, or it belongs to a different account. The API gives the same error for both. Check the IDs. Get them again from the list endpoints. |
429 | rate_limited: The account sent more than 60 requests in one minute. Wait for the number of seconds in the Retry-After header, then retry. |
500 | response_too_large, internal_error: The response is larger than 1 MB, or the API has an internal error. For response_too_large, ask for fewer rows or metrics. For internal_error, contact AnyTrack support with the requestId. |
503 | service_unavailable: The service is not available for a short time. Retry later, and wait longer after each failed retry. |
Request example
Section titled “Request example”Command template. Replace the path placeholders. Add the query parameters that you need. This is not a recorded request or response.
curl --request GET 'https://api.anytrack.io/v1/properties/{propertyId}/webhooks' \ --header 'Authorization: Bearer YOUR_API_KEY'