Call Lifecycle Events

Events emitted as a call progresses from ringing through to billing.

call.answered

POST

https://your-webhook-endpoint.example.com

/call.answered

call.answered › Request Body

CallAnsweredEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.answered

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.answered › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

POST/call.answered

curl https://your-webhook-endpoint.example.com/call.answered \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "created": "2026-08-20T01:18:04.166Z",
  "data": {
    "call": {
      "answeredAt": "2026-08-20T01:18:04.168Z",
      "assignedContact": {},
      "assignedUser": {
        "email": "Shirley45@hotmail.com",
        "firstName": "Myrl",
        "jobTitle": "National Operations Consultant",
        "lastName": "Frami",
        "mobile": "+10344926084",
        "userId": "32289373-aab6-44c5-a236-3d5c7a627a66"
      },
      "companyNumber": "+16282285706",
      "contactNumber": "+15137433235",
      "direction": "inbound",
      "directoryTarget": {
        "displayName": "Wendy Stokes",
        "email": "Allan39@yahoo.com",
        "extension": 2077643,
        "id": "0eda2594-5e9a-4848-8609-3405d5c61675",
        "type": "user"
      },
      "forms": [],
      "highlights": [],
      "id": "0678b015-fd5b-4237-bc01-edc9bd766e28",
      "initiator": "+13866896876",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.167Z",
      "lastModifiedTimestamp": 1787188684167,
      "parties": [
        {
          "id": "+16225641808",
          "type": "phone",
          "isInternal": false,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.167Z",
              "joinedTimestamp": 1787188684167,
              "vendorCallId": "CAA73411F6CF28440795D622881EF9FB1F"
            }
          ],
          "displayValue": "+1 604-708-7009"
        },
        {
          "id": "620ff35e-bb63-4577-8225-3bcba1815e26",
          "type": "user",
          "isInternal": true,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.167Z",
              "joinedTimestamp": 1787188684167,
              "vendorCallId": "CAB9411D8C08ED4A6E926868B457A72C5E"
            }
          ],
          "dials": [
            {
              "dialTimestamp": 1787188684167,
              "dialAt": "2026-08-20T01:18:04.167Z",
              "reason": "directDial"
            }
          ],
          "extension": 7992828,
          "email": "Heidi.Koss@yahoo.com",
          "displayValue": "Madilyn Feil",
          "timezone": "Asia/Aden"
        }
      ],
      "recipient": "4360c25d-9db2-43c4-b977-caee5d20c212",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.167Z",
      "startedTimestamp": 1787188684167,
      "status": "started",
      "summary": {
        "companyNumberDescription": "Called in to +19489508520",
        "contactNumberDescription": "Called in from +17611813032",
        "header": "Inbound call from +14463499868 to Marta Nader"
      },
      "user": {
        "email": "Lindsey_Blanda-Wehner27@hotmail.com",
        "firstName": "Derek",
        "jobTitle": "Product Interactions Assistant",
        "lastName": "Dare",
        "mobile": "+18391395643",
        "userId": "60eca823-0bfe-4a0f-af51-6dbd59411e53"
      },
      "vendor": "twilio",
      "vendorCallId": "CA15D334CC7B4E4645ABA4A13F42611CE0",
      "waitTime": 13937,
      "waitTimeText": "a few seconds"
    }
  },
  "id": "7f0213be-526b-4bc5-b4f0-15af510cab68",
  "timestamp": 1787188684166,
  "type": "call.answered",
  "version": "2020-07-15"
}'

Example Request Body

{
  "created": "2026-08-20T01:18:04.166Z",
  "data": {
    "call": {
      "answeredAt": "2026-08-20T01:18:04.168Z",
      "assignedContact": {},
      "assignedUser": {
        "email": "Shirley45@hotmail.com",
        "firstName": "Myrl",
        "jobTitle": "National Operations Consultant",
        "lastName": "Frami",
        "mobile": "+10344926084",
        "userId": "32289373-aab6-44c5-a236-3d5c7a627a66"
      },
      "companyNumber": "+16282285706",
      "contactNumber": "+15137433235",
      "direction": "inbound",
      "directoryTarget": {
        "displayName": "Wendy Stokes",
        "email": "Allan39@yahoo.com",
        "extension": 2077643,
        "id": "0eda2594-5e9a-4848-8609-3405d5c61675",
        "type": "user"
      },
      "forms": [],
      "highlights": [],
      "id": "0678b015-fd5b-4237-bc01-edc9bd766e28",
      "initiator": "+13866896876",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.167Z",
      "lastModifiedTimestamp": 1787188684167,
      "parties": [
        {
          "id": "+16225641808",
          "type": "phone",
          "isInternal": false,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.167Z",
              "joinedTimestamp": 1787188684167,
              "vendorCallId": "CAA73411F6CF28440795D622881EF9FB1F"
            }
          ],
          "displayValue": "+1 604-708-7009"
        },
        {
          "id": "620ff35e-bb63-4577-8225-3bcba1815e26",
          "type": "user",
          "isInternal": true,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.167Z",
              "joinedTimestamp": 1787188684167,
              "vendorCallId": "CAB9411D8C08ED4A6E926868B457A72C5E"
            }
          ],
          "dials": [
            {
              "dialTimestamp": 1787188684167,
              "dialAt": "2026-08-20T01:18:04.167Z",
              "reason": "directDial"
            }
          ],
          "extension": 7992828,
          "email": "Heidi.Koss@yahoo.com",
          "displayValue": "Madilyn Feil",
          "timezone": "Asia/Aden"
        }
      ],
      "recipient": "4360c25d-9db2-43c4-b977-caee5d20c212",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.167Z",
      "startedTimestamp": 1787188684167,
      "status": "started",
      "summary": {
        "companyNumberDescription": "Called in to +19489508520",
        "contactNumberDescription": "Called in from +17611813032",
        "header": "Inbound call from +14463499868 to Marta Nader"
      },
      "user": {
        "email": "Lindsey_Blanda-Wehner27@hotmail.com",
        "firstName": "Derek",
        "jobTitle": "Product Interactions Assistant",
        "lastName": "Dare",
        "mobile": "+18391395643",
        "userId": "60eca823-0bfe-4a0f-af51-6dbd59411e53"
      },
      "vendor": "twilio",
      "vendorCallId": "CA15D334CC7B4E4645ABA4A13F42611CE0",
      "waitTime": 13937,
      "waitTimeText": "a few seconds"
    }
  },
  "id": "7f0213be-526b-4bc5-b4f0-15af510cab68",
  "timestamp": 1787188684166,
  "type": "call.answered",
  "version": "2020-07-15"
}

json

application/json

Example Responses

No example specified for this content type

call.ended

POST

https://your-webhook-endpoint.example.com

/call.ended

call.ended › Request Body

CallEndedEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.ended

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.ended › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

POST/call.ended

curl https://your-webhook-endpoint.example.com/call.ended \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "created": "2026-08-20T01:18:04.172Z",
  "data": {
    "call": {
      "answeredAt": "2026-08-20T01:18:04.173Z",
      "assignedContact": {
        "companyName": "Bins, Kihn and Simonis",
        "emails": [
          {
            "email": null,
            "label": "work"
          }
        ],
        "firstName": "Brooke",
        "id": "a3ede5eb-9df7-40f4-9907-97fae62e7089",
        "jobTitle": null,
        "lastName": "Reynolds",
        "phoneNumbers": [
          {
            "label": "work",
            "numberRaw": "18896081364",
            "numberE164": "+19566210079",
            "numberDisplay": "+1 757-374-6993"
          },
          {
            "label": "mobile",
            "numberRaw": "16551962545",
            "numberE164": "+12660990052",
            "numberDisplay": "+1 670-702-3391"
          }
        ],
        "phonebookId": "e9b4a45b-747f-414c-b91d-088a1bff8b6d",
        "phonebookName": "claudeo decerno"
      },
      "assignedUser": {
        "email": "Peyton6@yahoo.com",
        "firstName": "Ida",
        "jobTitle": "Chief Quality Officer",
        "lastName": "Lehner",
        "mobile": null,
        "userId": "ae90b0bb-6235-4b2a-aba5-4f25ba5cd3d0"
      },
      "companyNumber": "+13997139456",
      "contactNumber": "+11755535665",
      "direction": "outbound",
      "duration": 76603,
      "durationText": "a minute",
      "endedAt": "2026-08-20T01:18:04.173Z",
      "forms": [],
      "highlights": [],
      "id": "d5071f2b-322e-4f12-9fa6-1fc2de4853e8",
      "initiator": "9f4931fb-87e6-41ce-aadc-95044a27995f",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.173Z",
      "lastModifiedTimestamp": 1787188684173,
      "outcome": {
        "status": "answered"
      },
      "parties": [
        {
          "id": "6d4f60e8-d2e6-4d5a-89da-0920d94d25b4",
          "type": "user",
          "isInternal": true,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.173Z",
              "joinedTimestamp": 1787188684173,
              "leftAt": "2026-08-20T01:18:04.173Z",
              "leftTimestamp": 1787188684173,
              "durationSec": 76,
              "vendorCallId": "CAF2CF06AA00FC40F69BD14AAF9CAEC4AA"
            }
          ],
          "extension": 6520785,
          "email": "Kattie_Halvorson8@hotmail.com",
          "displayValue": "Emerald Wisoky",
          "timezone": "Asia/Bangkok"
        },
        {
          "id": "+11829989020",
          "type": "phone",
          "isInternal": false,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.173Z",
              "joinedTimestamp": 1787188684173,
              "leftAt": "2026-08-20T01:18:04.173Z",
              "leftTimestamp": 1787188684173,
              "durationSec": 70,
              "vendorCallId": "CA2FEBBDBFA0A74B948B74BFF5860624A5"
            }
          ],
          "dials": [
            {
              "dialTimestamp": 1787188684173,
              "dialAt": "2026-08-20T01:18:04.173Z",
              "reason": "directDial"
            }
          ],
          "displayValue": "Samantha Heidenreich"
        }
      ],
      "recipient": "+10687287304",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.173Z",
      "startedTimestamp": 1787188684173,
      "status": "ended",
      "summary": {
        "companyNumberDescription": "Called out from +10318887099",
        "contactNumberDescription": "Called out to +12908004361",
        "header": "Outbound call to Roger Bergnaum DDS from Jill Waelchi",
        "outcome": "Spoke for a minute"
      },
      "user": {
        "email": "Alberto.Ullrich@gmail.com",
        "firstName": "Garnett",
        "jobTitle": "Senior Integration Assistant",
        "lastName": "Smitham",
        "mobile": null,
        "userId": "c29a0915-34ec-485f-8ae9-d9593b17af79"
      },
      "vendor": "twilio",
      "vendorCallId": "CA2D6136799D4943CD8D9FDDB4B4446145",
      "waitTime": 5359,
      "waitTimeText": "a few seconds"
    }
  },
  "id": "429c82d9-5055-49d9-ade7-5890d8519400",
  "timestamp": 1787188684172,
  "type": "call.ended",
  "version": "2020-07-15"
}'

Example Request Body

{
  "created": "2026-08-20T01:18:04.172Z",
  "data": {
    "call": {
      "answeredAt": "2026-08-20T01:18:04.173Z",
      "assignedContact": {
        "companyName": "Bins, Kihn and Simonis",
        "emails": [
          {
            "email": null,
            "label": "work"
          }
        ],
        "firstName": "Brooke",
        "id": "a3ede5eb-9df7-40f4-9907-97fae62e7089",
        "jobTitle": null,
        "lastName": "Reynolds",
        "phoneNumbers": [
          {
            "label": "work",
            "numberRaw": "18896081364",
            "numberE164": "+19566210079",
            "numberDisplay": "+1 757-374-6993"
          },
          {
            "label": "mobile",
            "numberRaw": "16551962545",
            "numberE164": "+12660990052",
            "numberDisplay": "+1 670-702-3391"
          }
        ],
        "phonebookId": "e9b4a45b-747f-414c-b91d-088a1bff8b6d",
        "phonebookName": "claudeo decerno"
      },
      "assignedUser": {
        "email": "Peyton6@yahoo.com",
        "firstName": "Ida",
        "jobTitle": "Chief Quality Officer",
        "lastName": "Lehner",
        "mobile": null,
        "userId": "ae90b0bb-6235-4b2a-aba5-4f25ba5cd3d0"
      },
      "companyNumber": "+13997139456",
      "contactNumber": "+11755535665",
      "direction": "outbound",
      "duration": 76603,
      "durationText": "a minute",
      "endedAt": "2026-08-20T01:18:04.173Z",
      "forms": [],
      "highlights": [],
      "id": "d5071f2b-322e-4f12-9fa6-1fc2de4853e8",
      "initiator": "9f4931fb-87e6-41ce-aadc-95044a27995f",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.173Z",
      "lastModifiedTimestamp": 1787188684173,
      "outcome": {
        "status": "answered"
      },
      "parties": [
        {
          "id": "6d4f60e8-d2e6-4d5a-89da-0920d94d25b4",
          "type": "user",
          "isInternal": true,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.173Z",
              "joinedTimestamp": 1787188684173,
              "leftAt": "2026-08-20T01:18:04.173Z",
              "leftTimestamp": 1787188684173,
              "durationSec": 76,
              "vendorCallId": "CAF2CF06AA00FC40F69BD14AAF9CAEC4AA"
            }
          ],
          "extension": 6520785,
          "email": "Kattie_Halvorson8@hotmail.com",
          "displayValue": "Emerald Wisoky",
          "timezone": "Asia/Bangkok"
        },
        {
          "id": "+11829989020",
          "type": "phone",
          "isInternal": false,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.173Z",
              "joinedTimestamp": 1787188684173,
              "leftAt": "2026-08-20T01:18:04.173Z",
              "leftTimestamp": 1787188684173,
              "durationSec": 70,
              "vendorCallId": "CA2FEBBDBFA0A74B948B74BFF5860624A5"
            }
          ],
          "dials": [
            {
              "dialTimestamp": 1787188684173,
              "dialAt": "2026-08-20T01:18:04.173Z",
              "reason": "directDial"
            }
          ],
          "displayValue": "Samantha Heidenreich"
        }
      ],
      "recipient": "+10687287304",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.173Z",
      "startedTimestamp": 1787188684173,
      "status": "ended",
      "summary": {
        "companyNumberDescription": "Called out from +10318887099",
        "contactNumberDescription": "Called out to +12908004361",
        "header": "Outbound call to Roger Bergnaum DDS from Jill Waelchi",
        "outcome": "Spoke for a minute"
      },
      "user": {
        "email": "Alberto.Ullrich@gmail.com",
        "firstName": "Garnett",
        "jobTitle": "Senior Integration Assistant",
        "lastName": "Smitham",
        "mobile": null,
        "userId": "c29a0915-34ec-485f-8ae9-d9593b17af79"
      },
      "vendor": "twilio",
      "vendorCallId": "CA2D6136799D4943CD8D9FDDB4B4446145",
      "waitTime": 5359,
      "waitTimeText": "a few seconds"
    }
  },
  "id": "429c82d9-5055-49d9-ade7-5890d8519400",
  "timestamp": 1787188684172,
  "type": "call.ended",
  "version": "2020-07-15"
}

json

application/json

Example Responses

No example specified for this content type

call.hungup

POST

https://your-webhook-endpoint.example.com

/call.hungup

call.hungup › Request Body

CallHungupEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.hungup

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.hungup › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

POST/call.hungup

curl https://your-webhook-endpoint.example.com/call.hungup \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "created": "2026-08-20T01:18:04.169Z",
  "data": {
    "call": {
      "answeredAt": "2026-08-20T01:18:04.171Z",
      "assignedContact": {
        "companyName": "Hammes LLC",
        "emails": [
          {
            "email": null,
            "label": "work"
          }
        ],
        "firstName": "Lance",
        "id": "7ac04334-cee6-4240-837a-c5d617c18b7b",
        "jobTitle": null,
        "lastName": "Block",
        "phoneNumbers": [
          {
            "label": "work",
            "numberRaw": "10245360287",
            "numberE164": "+11487485191",
            "numberDisplay": "+1 146-582-7003"
          },
          {
            "label": "mobile",
            "numberRaw": "11469413498",
            "numberE164": "+14090709205",
            "numberDisplay": "+1 157-225-3882"
          }
        ],
        "phonebookId": "e47835be-db4f-43ad-a9eb-fb2c84759f3f",
        "phonebookName": "stipes tertius"
      },
      "assignedUser": {
        "email": "Brad98@hotmail.com",
        "firstName": "Keyshawn",
        "jobTitle": "Central Infrastructure Orchestrator",
        "lastName": "Buckridge",
        "mobile": null,
        "userId": "c0150399-370c-4379-8392-85712cac48f6"
      },
      "companyNumber": "+18387641085",
      "contactNumber": "+18761881987",
      "direction": "outbound",
      "forms": [],
      "highlights": [],
      "id": "13e92eeb-ae70-4a61-9290-1fdd6bde71bd",
      "initiator": "708b5973-5c0b-4849-9e50-f7b11f9ea08f",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.171Z",
      "lastModifiedTimestamp": 1787188684172,
      "parties": [
        {
          "id": "f3970024-8c81-4511-b287-87099f13fb30",
          "type": "user",
          "isInternal": true,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.172Z",
              "joinedTimestamp": 1787188684172,
              "leftAt": "2026-08-20T01:18:04.172Z",
              "leftTimestamp": 1787188684172,
              "durationSec": 77,
              "vendorCallId": "CA514222C4C92B4F05A88AFE22BAB2BA98"
            }
          ],
          "extension": 8569537,
          "email": "Candice.Kling23@hotmail.com",
          "displayValue": "Agustin McKenzie",
          "timezone": "Asia/Bishkek"
        },
        {
          "id": "+13067399900",
          "type": "phone",
          "isInternal": false,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.172Z",
              "joinedTimestamp": 1787188684172,
              "leftAt": "2026-08-20T01:18:04.172Z",
              "leftTimestamp": 1787188684172,
              "durationSec": 70,
              "vendorCallId": "CA19B5C3EA1DFB4103AA246FAD3DB0E293"
            }
          ],
          "dials": [
            {
              "dialTimestamp": 1787188684172,
              "dialAt": "2026-08-20T01:18:04.172Z",
              "reason": "directDial"
            }
          ],
          "displayValue": "Harvey Collier"
        }
      ],
      "recipient": "+16089290827",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.171Z",
      "startedTimestamp": 1787188684172,
      "status": "started",
      "summary": {
        "companyNumberDescription": "Called out from +13543431229",
        "contactNumberDescription": "Called out to +17263786975",
        "header": "Outbound call to Krystel Dach-Crooks from Jerald O'\''Conner",
        "outcome": "Spoke for a minute"
      },
      "user": {
        "email": "Grace.Beahan48@yahoo.com",
        "firstName": "Taylor",
        "jobTitle": "Product Marketing Manager",
        "lastName": "Wyman",
        "mobile": null,
        "userId": "f323c42a-ee23-46e2-8e0e-dbaf6a576d69"
      },
      "vendor": "twilio",
      "vendorCallId": "CA8B4676F65DA045DEAC7A415B9F4DFB58",
      "waitTime": 5359,
      "waitTimeText": "a few seconds"
    }
  },
  "id": "cc60ebdf-2a2a-4148-9b5c-f29a2cadec85",
  "timestamp": 1787188684169,
  "type": "call.hungup",
  "version": "2020-07-15"
}'

Example Request Body

{
  "created": "2026-08-20T01:18:04.169Z",
  "data": {
    "call": {
      "answeredAt": "2026-08-20T01:18:04.171Z",
      "assignedContact": {
        "companyName": "Hammes LLC",
        "emails": [
          {
            "email": null,
            "label": "work"
          }
        ],
        "firstName": "Lance",
        "id": "7ac04334-cee6-4240-837a-c5d617c18b7b",
        "jobTitle": null,
        "lastName": "Block",
        "phoneNumbers": [
          {
            "label": "work",
            "numberRaw": "10245360287",
            "numberE164": "+11487485191",
            "numberDisplay": "+1 146-582-7003"
          },
          {
            "label": "mobile",
            "numberRaw": "11469413498",
            "numberE164": "+14090709205",
            "numberDisplay": "+1 157-225-3882"
          }
        ],
        "phonebookId": "e47835be-db4f-43ad-a9eb-fb2c84759f3f",
        "phonebookName": "stipes tertius"
      },
      "assignedUser": {
        "email": "Brad98@hotmail.com",
        "firstName": "Keyshawn",
        "jobTitle": "Central Infrastructure Orchestrator",
        "lastName": "Buckridge",
        "mobile": null,
        "userId": "c0150399-370c-4379-8392-85712cac48f6"
      },
      "companyNumber": "+18387641085",
      "contactNumber": "+18761881987",
      "direction": "outbound",
      "forms": [],
      "highlights": [],
      "id": "13e92eeb-ae70-4a61-9290-1fdd6bde71bd",
      "initiator": "708b5973-5c0b-4849-9e50-f7b11f9ea08f",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.171Z",
      "lastModifiedTimestamp": 1787188684172,
      "parties": [
        {
          "id": "f3970024-8c81-4511-b287-87099f13fb30",
          "type": "user",
          "isInternal": true,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.172Z",
              "joinedTimestamp": 1787188684172,
              "leftAt": "2026-08-20T01:18:04.172Z",
              "leftTimestamp": 1787188684172,
              "durationSec": 77,
              "vendorCallId": "CA514222C4C92B4F05A88AFE22BAB2BA98"
            }
          ],
          "extension": 8569537,
          "email": "Candice.Kling23@hotmail.com",
          "displayValue": "Agustin McKenzie",
          "timezone": "Asia/Bishkek"
        },
        {
          "id": "+13067399900",
          "type": "phone",
          "isInternal": false,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.172Z",
              "joinedTimestamp": 1787188684172,
              "leftAt": "2026-08-20T01:18:04.172Z",
              "leftTimestamp": 1787188684172,
              "durationSec": 70,
              "vendorCallId": "CA19B5C3EA1DFB4103AA246FAD3DB0E293"
            }
          ],
          "dials": [
            {
              "dialTimestamp": 1787188684172,
              "dialAt": "2026-08-20T01:18:04.172Z",
              "reason": "directDial"
            }
          ],
          "displayValue": "Harvey Collier"
        }
      ],
      "recipient": "+16089290827",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.171Z",
      "startedTimestamp": 1787188684172,
      "status": "started",
      "summary": {
        "companyNumberDescription": "Called out from +13543431229",
        "contactNumberDescription": "Called out to +17263786975",
        "header": "Outbound call to Krystel Dach-Crooks from Jerald O'Conner",
        "outcome": "Spoke for a minute"
      },
      "user": {
        "email": "Grace.Beahan48@yahoo.com",
        "firstName": "Taylor",
        "jobTitle": "Product Marketing Manager",
        "lastName": "Wyman",
        "mobile": null,
        "userId": "f323c42a-ee23-46e2-8e0e-dbaf6a576d69"
      },
      "vendor": "twilio",
      "vendorCallId": "CA8B4676F65DA045DEAC7A415B9F4DFB58",
      "waitTime": 5359,
      "waitTimeText": "a few seconds"
    }
  },
  "id": "cc60ebdf-2a2a-4148-9b5c-f29a2cadec85",
  "timestamp": 1787188684169,
  "type": "call.hungup",
  "version": "2020-07-15"
}

json

application/json

Example Responses

No example specified for this content type

call.not_answered

POST

https://your-webhook-endpoint.example.com

/call.not_answered

call.not_answered › Request Body

CallNotAnsweredEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.not_answered

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.not_answered › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

POST/call.not_answered

curl https://your-webhook-endpoint.example.com/call.not_answered \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "created": "2026-08-20T01:18:04.168Z",
  "data": {
    "call": {
      "assignedContact": {},
      "assignedUser": {},
      "companyNumber": "+18430074667",
      "contactNumber": "+17877566976",
      "direction": "inbound",
      "directoryTarget": {
        "displayName": "Sheila VonRueden MD",
        "email": "Nicole_Ritchie@yahoo.com",
        "extension": 8144430,
        "id": "0e77da83-1a53-4d2a-89eb-cf75d108cd57",
        "type": "user"
      },
      "forms": [],
      "highlights": [],
      "id": "f65a97a2-b2b8-4c02-b1ef-30c1ca93f171",
      "initiator": "+14844636626",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.169Z",
      "lastModifiedTimestamp": 1787188684169,
      "parties": [
        {
          "id": "+17888472220",
          "type": "phone",
          "isInternal": false,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.169Z",
              "joinedTimestamp": 1787188684169,
              "vendorCallId": "CA067C4D0ACE464289BC84884C609EEF67"
            }
          ],
          "displayValue": "+1 865-746-9933"
        },
        {
          "id": "202ad8f0-0016-420e-be6b-9e6b0bb049b9",
          "type": "user",
          "isInternal": true,
          "dials": [
            {
              "dialTimestamp": 1787188684169,
              "dialAt": "2026-08-20T01:18:04.169Z",
              "reason": "directDial"
            }
          ],
          "extension": 5413851,
          "email": "Nettie.Feest-Pacocha@hotmail.com",
          "displayValue": "Cortez Schmitt",
          "timezone": "Africa/Maseru"
        }
      ],
      "recipient": "40700db4-c59e-4a6e-abaf-bd76d8a2354e",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.169Z",
      "startedTimestamp": 1787188684169,
      "status": "started",
      "summary": {
        "companyNumberDescription": "Called in to +10015577219",
        "contactNumberDescription": "Called in from +14969077203",
        "header": "Inbound call from +18513578212 to Jamaal Kiehn"
      },
      "user": {},
      "vendor": "twilio",
      "vendorCallId": "CA0B7EAF9B240948B9B077C096F22EC4A1"
    }
  },
  "id": "64c5dbc9-c4d8-47d2-9010-d8d119ff4d43",
  "timestamp": 1787188684168,
  "type": "call.not_answered",
  "version": "2020-07-15"
}'

Example Request Body

{
  "created": "2026-08-20T01:18:04.168Z",
  "data": {
    "call": {
      "assignedContact": {},
      "assignedUser": {},
      "companyNumber": "+18430074667",
      "contactNumber": "+17877566976",
      "direction": "inbound",
      "directoryTarget": {
        "displayName": "Sheila VonRueden MD",
        "email": "Nicole_Ritchie@yahoo.com",
        "extension": 8144430,
        "id": "0e77da83-1a53-4d2a-89eb-cf75d108cd57",
        "type": "user"
      },
      "forms": [],
      "highlights": [],
      "id": "f65a97a2-b2b8-4c02-b1ef-30c1ca93f171",
      "initiator": "+14844636626",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.169Z",
      "lastModifiedTimestamp": 1787188684169,
      "parties": [
        {
          "id": "+17888472220",
          "type": "phone",
          "isInternal": false,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.169Z",
              "joinedTimestamp": 1787188684169,
              "vendorCallId": "CA067C4D0ACE464289BC84884C609EEF67"
            }
          ],
          "displayValue": "+1 865-746-9933"
        },
        {
          "id": "202ad8f0-0016-420e-be6b-9e6b0bb049b9",
          "type": "user",
          "isInternal": true,
          "dials": [
            {
              "dialTimestamp": 1787188684169,
              "dialAt": "2026-08-20T01:18:04.169Z",
              "reason": "directDial"
            }
          ],
          "extension": 5413851,
          "email": "Nettie.Feest-Pacocha@hotmail.com",
          "displayValue": "Cortez Schmitt",
          "timezone": "Africa/Maseru"
        }
      ],
      "recipient": "40700db4-c59e-4a6e-abaf-bd76d8a2354e",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.169Z",
      "startedTimestamp": 1787188684169,
      "status": "started",
      "summary": {
        "companyNumberDescription": "Called in to +10015577219",
        "contactNumberDescription": "Called in from +14969077203",
        "header": "Inbound call from +18513578212 to Jamaal Kiehn"
      },
      "user": {},
      "vendor": "twilio",
      "vendorCallId": "CA0B7EAF9B240948B9B077C096F22EC4A1"
    }
  },
  "id": "64c5dbc9-c4d8-47d2-9010-d8d119ff4d43",
  "timestamp": 1787188684168,
  "type": "call.not_answered",
  "version": "2020-07-15"
}

json

application/json

Example Responses

No example specified for this content type

call.started

POST

https://your-webhook-endpoint.example.com

/call.started

call.started › Request Body

CallStartedEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.started

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.started › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

POST/call.started

curl https://your-webhook-endpoint.example.com/call.started \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "created": "2026-08-20T01:18:04.160Z",
  "data": {
    "call": {
      "assignedContact": {},
      "assignedUser": {},
      "companyNumber": "+16934623110",
      "contactNumber": "+17259096614",
      "direction": "inbound",
      "directoryTarget": {
        "displayName": "Stacey Ledner DDS",
        "email": "Stephon_Stroman30@hotmail.com",
        "extension": 3071750,
        "id": "7ed7debc-ac85-419f-b658-96a07578d280",
        "type": "user"
      },
      "forms": [],
      "highlights": [],
      "id": "344b05fb-b42d-4a8e-b26b-eb46a1156128",
      "initiator": "+17717359291",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.163Z",
      "lastModifiedTimestamp": 1787188684163,
      "parties": [
        {
          "id": "+18802552396",
          "type": "phone",
          "isInternal": false,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.164Z",
              "joinedTimestamp": 1787188684164,
              "vendorCallId": "CA6FC5A357A0E8451988FA260175E84F82"
            }
          ],
          "displayValue": "+1 927-006-3393"
        }
      ],
      "recipient": "4c1392f7-0917-4f9f-ac6c-4dedc85d0e9b",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.163Z",
      "startedTimestamp": 1787188684163,
      "status": "started",
      "summary": {
        "companyNumberDescription": "Called in to +10345192437",
        "contactNumberDescription": "Called in from +10870266222",
        "header": "Inbound call from +13085741650 to Heather Witting"
      },
      "user": {},
      "vendor": "twilio",
      "vendorCallId": "CA856FE358CDAB4031A8B8CC203A51D633"
    }
  },
  "id": "5ca41d63-e4b7-4e46-b016-d5a12cf76375",
  "timestamp": 1787188684160,
  "type": "call.started",
  "version": "2020-07-15"
}'

Example Request Body

{
  "created": "2026-08-20T01:18:04.160Z",
  "data": {
    "call": {
      "assignedContact": {},
      "assignedUser": {},
      "companyNumber": "+16934623110",
      "contactNumber": "+17259096614",
      "direction": "inbound",
      "directoryTarget": {
        "displayName": "Stacey Ledner DDS",
        "email": "Stephon_Stroman30@hotmail.com",
        "extension": 3071750,
        "id": "7ed7debc-ac85-419f-b658-96a07578d280",
        "type": "user"
      },
      "forms": [],
      "highlights": [],
      "id": "344b05fb-b42d-4a8e-b26b-eb46a1156128",
      "initiator": "+17717359291",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.163Z",
      "lastModifiedTimestamp": 1787188684163,
      "parties": [
        {
          "id": "+18802552396",
          "type": "phone",
          "isInternal": false,
          "connections": [
            {
              "joinedAt": "2026-08-20T01:18:04.164Z",
              "joinedTimestamp": 1787188684164,
              "vendorCallId": "CA6FC5A357A0E8451988FA260175E84F82"
            }
          ],
          "displayValue": "+1 927-006-3393"
        }
      ],
      "recipient": "4c1392f7-0917-4f9f-ac6c-4dedc85d0e9b",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.163Z",
      "startedTimestamp": 1787188684163,
      "status": "started",
      "summary": {
        "companyNumberDescription": "Called in to +10345192437",
        "contactNumberDescription": "Called in from +10870266222",
        "header": "Inbound call from +13085741650 to Heather Witting"
      },
      "user": {},
      "vendor": "twilio",
      "vendorCallId": "CA856FE358CDAB4031A8B8CC203A51D633"
    }
  },
  "id": "5ca41d63-e4b7-4e46-b016-d5a12cf76375",
  "timestamp": 1787188684160,
  "type": "call.started",
  "version": "2020-07-15"
}

json

application/json

Example Responses

No example specified for this content type

call.tariffed

POST

https://your-webhook-endpoint.example.com

/call.tariffed

call.tariffed › Request Body

CallTariffedEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.tariffed

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.tariffed › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

POST/call.tariffed

curl https://your-webhook-endpoint.example.com/call.tariffed \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "created": "2026-08-20T01:18:04.192Z",
  "data": {
    "call": {
      "answeredAt": "2026-08-20T01:18:04.193Z",
      "assignedContact": {},
      "assignedUser": {
        "email": "Marianne.Hegmann18@hotmail.com",
        "firstName": "Lue",
        "jobTitle": "Internal Accountability Strategist",
        "lastName": "Pfannerstill",
        "mobile": "+17915247503",
        "userId": "ad8d4447-3177-4d88-a4e6-fff9d79f51c2"
      },
      "companyNumber": "+12245070159",
      "contactNumber": "+14544284433",
      "direction": "inbound",
      "directoryTarget": {
        "displayName": "Lew Parker",
        "email": "Lora_Veum-Berge37@yahoo.com",
        "extension": 2599730,
        "id": "558b928e-659b-453e-ba2d-d853b51dc13b",
        "type": "user"
      },
      "duration": 70779,
      "durationText": "a minute",
      "endedAt": "2026-08-20T01:18:04.193Z",
      "forms": [],
      "highlights": [],
      "id": "32d61eb0-9c5c-4c21-bf4b-cf0f31ceeec7",
      "initiator": "+18751140911",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.193Z",
      "lastModifiedTimestamp": 1787188684193,
      "outcome": {
        "status": "answered"
      },
      "parties": [
        {
          "isInternal": false,
          "displayValue": "+1 649-116-4880",
          "id": "+13983553496",
          "type": "phone",
          "connections": [
            {
              "joinedTimestamp": 1787188684193,
              "leftAt": "2026-08-20T01:18:04.193Z",
              "leftTimestamp": 1787188684193,
              "durationSec": 71,
              "vendorCallId": "CAB13D7182575845D9B3814487DFF844B9",
              "joinedAt": "2026-08-20T01:18:04.193Z"
            }
          ]
        },
        {
          "isInternal": true,
          "displayValue": "Missouri Lesch-Collier",
          "dials": [
            {
              "dialTimestamp": 1787188684193,
              "reason": "directDial",
              "dialAt": "2026-08-20T01:18:04.193Z"
            }
          ],
          "extension": 2127713,
          "id": "84c23134-c30d-49d1-82dd-0a6933e457d2",
          "type": "user",
          "connections": [
            {
              "joinedTimestamp": 1787188684193,
              "leftAt": "2026-08-20T01:18:04.193Z",
              "leftTimestamp": 1787188684193,
              "durationSec": 55,
              "vendorCallId": "CA57597439DB41423E956C2D5A7CBB3429",
              "joinedAt": "2026-08-20T01:18:04.193Z"
            }
          ],
          "email": "Rex_Shields@gmail.com",
          "timezone": "Australia/Lord_Howe"
        }
      ],
      "recipient": "bcfc1319-fbdb-4090-8b20-22fdf72ed0b2",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.193Z",
      "startedTimestamp": 1787188684193,
      "status": "ended",
      "summary": {
        "companyNumberDescription": "Called in to +11626013467",
        "contactNumberDescription": "Called in from +13438236004",
        "header": "Inbound call from +13610408297 to Emmie Bartell",
        "outcome": "Spoke for a minute"
      },
      "tariff": {
        "connectedPartyTariffs": [
          {
            "amount": 0,
            "total": 0,
            "quantity": 2,
            "initiator": "+11599807198",
            "recipient": "+13139247370",
            "routeDescription": "Unmatched Call Route - Zero Tariff",
            "transport": "carrier",
            "durationSec": 70.141,
            "vendorCallId": "CA8FE704B6B7D64A6C80DF087A3412D8BC",
            "direction": null
          },
          {
            "amount": 0,
            "total": 0,
            "quantity": 1,
            "initiator": "SYSTEM",
            "recipient": "client:f207793f_5320_47be_9f83_2f5a298b6aa9",
            "recipientCountry": null,
            "routeDescription": "High-volume customer - Inbound call surcharge",
            "transport": "voip",
            "durationSec": 56.001,
            "vendorCallId": "CAF19A2D10C0B9403F966B478E4F49CF33",
            "direction": "outbound"
          }
        ],
        "total": 0
      },
      "user": {
        "email": "Tanner.Ortiz51@gmail.com",
        "firstName": "Antonia",
        "jobTitle": "International Operations Planner",
        "lastName": "Dickens",
        "mobile": "+17372892016",
        "userId": "57a3a197-3ee5-44bb-bb8e-97988378729f"
      },
      "vendor": "twilio",
      "vendorCallId": "CADAA8A8B9B0534F25A61535D0A9E62078",
      "waitTime": 13937,
      "waitTimeText": "a few seconds"
    }
  },
  "id": "17149ea7-899b-4166-ae80-7272c2a97c25",
  "timestamp": 1787188684192,
  "type": "call.tariffed",
  "version": "2020-07-15"
}'

Example Request Body

{
  "created": "2026-08-20T01:18:04.192Z",
  "data": {
    "call": {
      "answeredAt": "2026-08-20T01:18:04.193Z",
      "assignedContact": {},
      "assignedUser": {
        "email": "Marianne.Hegmann18@hotmail.com",
        "firstName": "Lue",
        "jobTitle": "Internal Accountability Strategist",
        "lastName": "Pfannerstill",
        "mobile": "+17915247503",
        "userId": "ad8d4447-3177-4d88-a4e6-fff9d79f51c2"
      },
      "companyNumber": "+12245070159",
      "contactNumber": "+14544284433",
      "direction": "inbound",
      "directoryTarget": {
        "displayName": "Lew Parker",
        "email": "Lora_Veum-Berge37@yahoo.com",
        "extension": 2599730,
        "id": "558b928e-659b-453e-ba2d-d853b51dc13b",
        "type": "user"
      },
      "duration": 70779,
      "durationText": "a minute",
      "endedAt": "2026-08-20T01:18:04.193Z",
      "forms": [],
      "highlights": [],
      "id": "32d61eb0-9c5c-4c21-bf4b-cf0f31ceeec7",
      "initiator": "+18751140911",
      "isConference": false,
      "isInternal": false,
      "lastModifiedAt": "2026-08-20T01:18:04.193Z",
      "lastModifiedTimestamp": 1787188684193,
      "outcome": {
        "status": "answered"
      },
      "parties": [
        {
          "isInternal": false,
          "displayValue": "+1 649-116-4880",
          "id": "+13983553496",
          "type": "phone",
          "connections": [
            {
              "joinedTimestamp": 1787188684193,
              "leftAt": "2026-08-20T01:18:04.193Z",
              "leftTimestamp": 1787188684193,
              "durationSec": 71,
              "vendorCallId": "CAB13D7182575845D9B3814487DFF844B9",
              "joinedAt": "2026-08-20T01:18:04.193Z"
            }
          ]
        },
        {
          "isInternal": true,
          "displayValue": "Missouri Lesch-Collier",
          "dials": [
            {
              "dialTimestamp": 1787188684193,
              "reason": "directDial",
              "dialAt": "2026-08-20T01:18:04.193Z"
            }
          ],
          "extension": 2127713,
          "id": "84c23134-c30d-49d1-82dd-0a6933e457d2",
          "type": "user",
          "connections": [
            {
              "joinedTimestamp": 1787188684193,
              "leftAt": "2026-08-20T01:18:04.193Z",
              "leftTimestamp": 1787188684193,
              "durationSec": 55,
              "vendorCallId": "CA57597439DB41423E956C2D5A7CBB3429",
              "joinedAt": "2026-08-20T01:18:04.193Z"
            }
          ],
          "email": "Rex_Shields@gmail.com",
          "timezone": "Australia/Lord_Howe"
        }
      ],
      "recipient": "bcfc1319-fbdb-4090-8b20-22fdf72ed0b2",
      "recordings": [],
      "startedAt": "2026-08-20T01:18:04.193Z",
      "startedTimestamp": 1787188684193,
      "status": "ended",
      "summary": {
        "companyNumberDescription": "Called in to +11626013467",
        "contactNumberDescription": "Called in from +13438236004",
        "header": "Inbound call from +13610408297 to Emmie Bartell",
        "outcome": "Spoke for a minute"
      },
      "tariff": {
        "connectedPartyTariffs": [
          {
            "amount": 0,
            "total": 0,
            "quantity": 2,
            "initiator": "+11599807198",
            "recipient": "+13139247370",
            "routeDescription": "Unmatched Call Route - Zero Tariff",
            "transport": "carrier",
            "durationSec": 70.141,
            "vendorCallId": "CA8FE704B6B7D64A6C80DF087A3412D8BC",
            "direction": null
          },
          {
            "amount": 0,
            "total": 0,
            "quantity": 1,
            "initiator": "SYSTEM",
            "recipient": "client:f207793f_5320_47be_9f83_2f5a298b6aa9",
            "recipientCountry": null,
            "routeDescription": "High-volume customer - Inbound call surcharge",
            "transport": "voip",
            "durationSec": 56.001,
            "vendorCallId": "CAF19A2D10C0B9403F966B478E4F49CF33",
            "direction": "outbound"
          }
        ],
        "total": 0
      },
      "user": {
        "email": "Tanner.Ortiz51@gmail.com",
        "firstName": "Antonia",
        "jobTitle": "International Operations Planner",
        "lastName": "Dickens",
        "mobile": "+17372892016",
        "userId": "57a3a197-3ee5-44bb-bb8e-97988378729f"
      },
      "vendor": "twilio",
      "vendorCallId": "CADAA8A8B9B0534F25A61535D0A9E62078",
      "waitTime": 13937,
      "waitTimeText": "a few seconds"
    }
  },
  "id": "17149ea7-899b-4166-ae80-7272c2a97c25",
  "timestamp": 1787188684192,
  "type": "call.tariffed",
  "version": "2020-07-15"
}

json

application/json

Example Responses

No example specified for this content type

Call Media Events

call.answered

POST

https://your-webhook-endpoint.example.com

/call.answered

call.answered › Request Body

CallAnsweredEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.answered

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.answered › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

call.ended

POST

https://your-webhook-endpoint.example.com

/call.ended

call.ended › Request Body

CallEndedEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.ended

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.ended › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

call.hungup

POST

https://your-webhook-endpoint.example.com

/call.hungup

call.hungup › Request Body

CallHungupEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.hungup

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.hungup › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

call.not_answered

POST

https://your-webhook-endpoint.example.com

/call.not_answered

call.not_answered › Request Body

CallNotAnsweredEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.not_answered

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.not_answered › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

call.started

POST

https://your-webhook-endpoint.example.com

/call.started

call.started › Request Body

CallStartedEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.started

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.started › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

call.tariffed

POST

https://your-webhook-endpoint.example.com

/call.tariffed

call.tariffed › Request Body

CallTariffedEvent

created

string · required

UTC timestamp of when the event was emitted

CallEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: call.tariffed

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

call.tariffed › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned