Skip to main content
Create Webhook Subscription
POST
POST
https://api.atzcrm.com/v1/subscribe

Create a new webhook subscription.

List of available events

Event NameEventResource
Candidate Addedcandidate.addedCandidate
Candidate Updatedcandidate.updatedCandidate
Candidate Deletedcandidate.deletedCandidate
Candidate Talent Stage Updatedcandidate.talent_stage.updatedCandidate
Job Application From External Sourcejob.application.from_external_sourceCandidate
Contact Addedcontact.addedContact
Contact Updatedcontact.updatedContact
Contact Deletedcontact.deletedContact
Organization Addedorganization.addedOrganization
Organization Updatedorganization.updatedOrganization
Organization Deletedorganization.deletedOrganization
Deal Addeddeal.addedDeal
Deal Updateddeal.updatedDeal
Deal Deleteddeal.deletedDeal
Job Addedjob.addedJob
Job Updatedjob.updatedJob
Job Deletedjob.deletedJob

Request

Body

  • eventNamestring

    >= 1 characters (required)

  • targetUrlstring (URL)

    >= 1 characters (required)

Response

201

Body

  • idinteger

    Example: 7

  • account_idinteger

    Example: 1

  • event_namestring

    Example: candidate.deleted

  • target_urlstring

    Example: https://xyz.com

  • sourcestring

    Example: public

  • created_atinteger

    Example: 1764200594

  • updated_atinteger

    Example: 1764200595

401

Body

  • unauthorised
400

Body

  • Unprocessable Entity

Response Example

{
"id": 7,
"account_id": 1,
"event_name": "candidate.deleted",
"target_url": "https://xyz.com",
"source": "public",
"created_at": 1764200594,
"updated_at": 1764200595
}