Skip to main content
Show All Webhook Subscriptions
GET
GET
https://api.atzcrm.com/v1/subscribe

Retrieve all webhook subscriptions for the authenticated account.

Request

GET

GET /v1/subscribe

Query Parameters

  • pageinteger

    The page number for pagination.

  • limitinteger

    Number of subscriptions per page (max 25).

Response

200

Body

The API returns a paginated list of webhook subscriptions.

  • total

    number

  • per_page

    number

  • current_page

    number

  • last_page

    number

  • next_page_url

    string | null

  • prev_page_url

    string | null

  • data

    array

Webhook Subscription Object

  • id

    number

  • event_name

    string

  • target_url

    string

Example Response

{
"total": 3,
"per_page": 25,
"current_page": 1,
"last_page": 1,
"next_page_url": null,
"prev_page_url": null,
"from": 1,
"to": 3,
"data": [
{
"id": 6,
"event_name": "job.application.from_external_source",
"target_url": "https://webhook.site/0519f242-c3c7-4e07-8187-adf5c5d63c9a"
},
{
"id": 5,
"event_name": "candidate.talent_stage.updated",
"target_url": "https://webhook.site/0519f242-c3c7-4e07-8187-adf5c5d63c9a"
},
{
"id": 1,
"event_name": "contact.updated",
"target_url": "https://01f70d5c4395.ngrok-free.app/v1/signal-hire/"
}
]
}
401

Error

  • unauthorized

Response Example

{
"total": 3,
"per_page": 25,
"current_page": 1,
"last_page": 1,
"next_page_url": null,
"prev_page_url": null,
"from": 1,
"to": 3,
"data": [
{
"id": 6,
"event_name": "job.application.from_external_source",
"target_url": "https://webhook.site/0519f242-c3c7-4e07-8187-adfd63c9a"
},
{
"id": 5,
"event_name": "candidate.talent_stage.updated",
"target_url": "https://webhook.site/0519f242-c3c7-4e07-8187-adfd63c9a"
},
{
"id": 1,
"event_name": "contact.updated",
"target_url": "https://webhook.site/0519f242-c3c7-4e07-8187-adfd63c9a"
}
]
}