Generic
- Contact
- Company
- User
- Workspace
Crm
- Opportunity
- Pipeline
- Stage
- Engagement
Scheduling
- Event Type
- Slot
- Event
Telephony
- Call
- Call Transcript
Widget
- Card View
Custom
- Fields
Engagement
Webhook Events
{
"event": "crmEngagement::created",
"data": {
"object": "resource",
"model": "crmEngagement",
"id": "<string>",
"fields": {
"type": "<string>",
"direction": "<string>",
"status": "<string>",
"title": "<string>",
"description": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"duration": "<integer>",
"owner": {
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
},
"users": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
],
"companies": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
],
"contacts": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
],
"opportunities": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
]
},
"createdAt": "2025-03-06T09:05:04.606Z",
"updatedAt": "2025-03-06T09:15:04.606Z",
"rawResource": null,
"warnings": []
}
}
// 200
Event Headers
The unique identifier of the connector
The unique identifier of the owner
A unique key to ensure idempotency of the webhook request
Event Body
The event type : crmEngagement::created
, crmEngagement::updated
or
crmEngagement::deleted
Available options: resource
The model identifier
The unique identifier
Type of engagement
Direction of the engagement
Engagement status
Subject or title of the engagement
Engagement content details
Start time in ISO 8601 format
End time in ISO 8601 format
Duration in seconds
Owner of the engagement
Related users
Related companies
Related contacts
Related opportunities
The creation timestamp
The last update timestamp
The raw resource data
Expected Response
200 OK
{
"event": "crmEngagement::created",
"data": {
"object": "resource",
"model": "crmEngagement",
"id": "<string>",
"fields": {
"type": "<string>",
"direction": "<string>",
"status": "<string>",
"title": "<string>",
"description": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"duration": "<integer>",
"owner": {
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
},
"users": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
],
"companies": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
],
"contacts": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
],
"opportunities": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
]
},
"createdAt": "2025-03-06T09:05:04.606Z",
"updatedAt": "2025-03-06T09:15:04.606Z",
"rawResource": null,
"warnings": []
}
}
// 200
{
"event": "crmEngagement::created",
"data": {
"object": "resource",
"model": "crmEngagement",
"id": "<string>",
"fields": {
"type": "<string>",
"direction": "<string>",
"status": "<string>",
"title": "<string>",
"description": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"duration": "<integer>",
"owner": {
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
},
"users": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
],
"companies": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
],
"contacts": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
],
"opportunities": [
{
"object": "resourceRef",
"model": "<string>",
"id": "<string>"
}
]
},
"createdAt": "2025-03-06T09:05:04.606Z",
"updatedAt": "2025-03-06T09:15:04.606Z",
"rawResource": null,
"warnings": []
}
}
// 200
Assistant
Responses are generated using AI and may contain mistakes.