Webhook Events

{
  "event": "crmOpportunity::created",
  "data": {
    "object": "resource",
    "model": "crmOpportunity",
    "id": "<string>",
    "fields": {
      "name": "<string>",
      "amount": "<number>",
      "currency": "<string>",
      "stage": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "pipeline": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "owner": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "contacts": [
        {
          "object": "resourceRef",
          "model": "<string>",
          "id": "<string>"
        }
      ],
      "companies": [
        {
          "object": "resourceRef",
          "model": "<string>",
          "id": "<string>"
        }
      ],
      "engagements": [
        {
          "object": "resourceRef",
          "model": "<string>",
          "id": "<string>"
        }
      ]
    },
    "createdAt": "2025-03-06T09:05:04.596Z",
    "updatedAt": "2025-03-06T09:15:04.596Z",
    "rawResource": null,
    "warnings": []
  }
}

// 200

Event Headers

string

required

The unique identifier of the connector

string

required

The unique identifier of the owner

string

required

A unique key to ensure idempotency of the webhook request

Event Body

enum<string>

required

The event type : crmOpportunity::created, crmOpportunity::updated or crmOpportunity::deleted

Opportunity Resource

required

Show properties

enum<string>

default:"resource"

required

Available options: resource

enum<string>

default:"crmOpportunity"

required

The model identifier

string

required

The unique identifier

object

required

Show properties

string

Opportunity name. Required string length: 1 - 250

string

Opportunity amount

string

Currency code. Required string length: 3 - 3

string

Stage of the opportunity

string

Pipeline of the opportunity

string

User that own the opportunity

string

Associated contacts

string

Associated companies

string

Associated engagements

string

required

The creation timestamp

string

required

The last update timestamp

any | null

The raw resource data

object[]

Show properties

string

required

The warning code

string

The warning message

Expected Response

200 OK

{
  "event": "crmOpportunity::created",
  "data": {
    "object": "resource",
    "model": "crmOpportunity",
    "id": "<string>",
    "fields": {
      "name": "<string>",
      "amount": "<number>",
      "currency": "<string>",
      "stage": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "pipeline": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "owner": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "contacts": [
        {
          "object": "resourceRef",
          "model": "<string>",
          "id": "<string>"
        }
      ],
      "companies": [
        {
          "object": "resourceRef",
          "model": "<string>",
          "id": "<string>"
        }
      ],
      "engagements": [
        {
          "object": "resourceRef",
          "model": "<string>",
          "id": "<string>"
        }
      ]
    },
    "createdAt": "2025-03-06T09:05:04.596Z",
    "updatedAt": "2025-03-06T09:15:04.596Z",
    "rawResource": null,
    "warnings": []
  }
}

// 200

Generic

Crm

Scheduling

Telephony

Widget

Custom

Webhook Events

Event Headers

Event Body

Expected Response

​Event Headers

​Event Body

​Expected Response

Event Headers

Event Body

Expected Response