Create Webhook Subscription
POST
POST
https://api.atzcrm.com/v1/subscribeCreate a new webhook subscription.
List of available events
| Event Name | Event | Resource |
|---|---|---|
| Candidate Added | candidate.added | Candidate |
| Candidate Updated | candidate.updated | Candidate |
| Candidate Deleted | candidate.deleted | Candidate |
| Candidate Talent Stage Updated | candidate.talent_stage.updated | Candidate |
| Job Application From External Source | job.application.from_external_source | Candidate |
| Contact Added | contact.added | Contact |
| Contact Updated | contact.updated | Contact |
| Contact Deleted | contact.deleted | Contact |
| Organization Added | organization.added | Organization |
| Organization Updated | organization.updated | Organization |
| Organization Deleted | organization.deleted | Organization |
| Deal Added | deal.added | Deal |
| Deal Updated | deal.updated | Deal |
| Deal Deleted | deal.deleted | Deal |
| Job Added | job.added | Job |
| Job Updated | job.updated | Job |
| Job Deleted | job.deleted | Job |
Request
Body
- eventName
string>= 1 characters (required)
- targetUrl
string (URL)>= 1 characters (required)
Response
201
Body
- id
integerExample: 7
- account_id
integerExample: 1
- event_name
stringExample: candidate.deleted
- target_url
stringExample: https://xyz.com
- source
stringExample: public
- created_at
integerExample: 1764200594
- updated_at
integerExample: 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
}