Skip to main content

​
Event Headers

​
x-conector-id
string
required
The unique identifier of the connector
​
x-owner-id
string
required
The unique identifier of the owner
​
x-idempotency-key
string
required
A unique key to ensure idempotency of the webhook request

​
Event Body

​
event
enum<string>
required
The event type : crmEngagement::created, crmEngagement::updated or crmEngagement::deleted
​
data
Engagement Resource
required

​
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