Event reference

All outbound events share the envelope described in Outbound webhooks and add workspaceId and integrationId.

Event	Fires when	Subscription
`call.completed`	A call technically ended	Opt in
`call.outcome.updated`	A user set or changed a call outcome	Opt in
`call.missed`	An inbound call was not answered	Opt in
`call.failed`	A call failed technically	Opt in
`note.created`	A note was added to a contact	Opt in
`callback.created`	A callback was scheduled	Opt in
`meeting.created`	A meeting was scheduled	Opt in
`recording.ready`	A recording finished processing	Opt in
`dnc.created`	A number was added to Do Not Call	Opt in
`test.ping`	You click Test webhook	Always

Select which events you receive in Integrations → Custom Integrations → Configure → Settings.

Shared entity references

Several events embed the same nested objects.

Object	Shape
`data.contact`	`{ id, externalId?, phoneNumber, fullName?, email? }`
`data.company`	`{ id, externalId?, name }`
`data.user`	`{ id, email?, fullName? }`

externalId is present when the record was linked through contact.upserted or company.upserted. Use it as your primary join key and fall back to phoneNumber.

`call.completed`

A call has technically ended, regardless of whether anyone recorded an outcome yet. Required: data.callId, data.fromNumber, data.toNumber, data.status, data.direction, data.endedAt

string

required

Ringee call UUID. Use it as the unique key for the activity in your CRM.

string

required

Originating E.164 number.

string

required

Destination E.164 number.

string

required

Final call status reported by the carrier.

string

required

inbound or outbound.

string (ISO-8601)

required

When the call ended.

string (ISO-8601)

When the call was initiated.

string (ISO-8601)

When the call was answered.

number

Total billed duration.

string

pending, ready or unavailable.

object

Contact reference.

object

Company reference.

object

Ringee user who handled the call.

{
  "event": "call.completed",
  "eventId": "evt_01HX5ZBN7Y0Q3S4M2K1WJ8V5DC",
  "occurredAt": "2026-05-23T14:42:18.000Z",
  "workspaceId": "org_2k7yX…",
  "integrationId": "ci_…",
  "data": {
    "callId": "f3b1…",
    "fromNumber": "+14155550100",
    "toNumber": "+14155550123",
    "status": "completed",
    "direction": "outbound",
    "durationSeconds": 142,
    "startedAt": "2026-05-23T14:39:56.000Z",
    "endedAt": "2026-05-23T14:42:18.000Z",
    "contact": {
      "id": "…",
      "externalId": "ext_contact_42",
      "phoneNumber": "+14155550123"
    }
  }
}

This event does not include the outcome. Outcomes arrive separately via call.outcome.updated, and may never arrive if the user never records one.

`call.outcome.updated`

A user recorded or changed the outcome of a call. This can happen well after call.completed. Required: data.callId, data.outcome, data.updatedAt

string

required

Ringee call UUID — match it against an existing activity.

string

required

The CallOutcome value, for example sale, interested, meeting_booked, voicemail, no_answer.

string (ISO-8601)

required

When the outcome was set.

string

Free-text note attached to the outcome.

object

Contact reference.

object

Company reference.

object

User who recorded the outcome.

{
  "event": "call.outcome.updated",
  "eventId": "evt_…",
  "occurredAt": "2026-05-23T14:50:00.000Z",
  "workspaceId": "org_…",
  "integrationId": "ci_…",
  "data": {
    "callId": "f3b1…",
    "outcome": "meeting_booked",
    "outcomeNote": "Demo scheduled for next Tuesday",
    "updatedAt": "2026-05-23T14:50:00.000Z"
  }
}

Update the existing activity — never create a second one. When the outcome is meeting_booked, a separate meeting.created event also fires.

`call.missed`

An inbound call arrived but nobody picked up. Required: data.callId, data.fromNumber, data.toNumber, data.occurredAt

string

Carrier-provided reason.

object

Contact reference.

object

Company reference.

object

User reference.

{
  "event": "call.missed",
  "eventId": "evt_…",
  "occurredAt": "2026-05-23T15:20:00.000Z",
  "workspaceId": "org_…",
  "integrationId": "ci_…",
  "data": {
    "callId": "c_…",
    "fromNumber": "+14155550123",
    "toNumber": "+14155550100",
    "occurredAt": "2026-05-23T15:20:00.000Z"
  }
}

For missed calls, resolve the contact primarily from fromNumber.

`call.failed`

The telephony stack reported a hard failure — busy, invalid number, network error. Required: data.callId, data.fromNumber, data.toNumber, data.occurredAt

string

Carrier error code, for example USER_BUSY.

string

Human-readable description.

object

Contact reference.

object

Company reference.

object

User reference.

{
  "event": "call.failed",
  "eventId": "evt_…",
  "occurredAt": "2026-05-23T15:25:00.000Z",
  "workspaceId": "org_…",
  "integrationId": "ci_…",
  "data": {
    "callId": "c_…",
    "fromNumber": "+14155550100",
    "toNumber": "+14155550123",
    "occurredAt": "2026-05-23T15:25:00.000Z",
    "errorCode": "USER_BUSY"
  }
}

`note.created`

Required: data.noteId, data.contact, data.content, data.createdAt

object

User who wrote the note.

{
  "event": "note.created",
  "eventId": "evt_…",
  "occurredAt": "2026-05-23T15:00:00.000Z",
  "workspaceId": "org_…",
  "integrationId": "ci_…",
  "data": {
    "noteId": "n_…",
    "contact": {
      "id": "…",
      "externalId": "ext_contact_42",
      "phoneNumber": "+14155550123"
    },
    "content": "Prefers email follow-up.",
    "createdAt": "2026-05-23T15:00:00.000Z"
  }
}

`callback.created`

Required: data.callbackId, data.contact, data.scheduledAt, data.status, data.createdAt

object

Originating call reference.

string

Free-text note.

object

User who scheduled it.

{
  "event": "callback.created",
  "eventId": "evt_…",
  "occurredAt": "2026-05-23T15:05:00.000Z",
  "workspaceId": "org_…",
  "integrationId": "ci_…",
  "data": {
    "callbackId": "cb_…",
    "contact": {
      "id": "…",
      "externalId": "ext_contact_42",
      "phoneNumber": "+14155550123"
    },
    "scheduledAt": "2026-05-24T10:00:00.000Z",
    "status": "pending",
    "createdAt": "2026-05-23T15:05:00.000Z"
  }
}

`meeting.created`

Fires when a user schedules a meeting. Independent of outcomes — if the outcome is meeting_booked, both call.outcome.updated and meeting.created fire. Required: data.meetingId, data.contact, data.scheduledAt, data.status, data.createdAt

string

Meeting title.

number

Duration in minutes.

string

Physical location or video link.

string

Notes.

string

Calendar provider event id, when synced to Google or Microsoft.

object

Originating call reference.

object

User reference.

{
  "event": "meeting.created",
  "eventId": "evt_…",
  "occurredAt": "2026-05-23T15:10:00.000Z",
  "workspaceId": "org_…",
  "integrationId": "ci_…",
  "data": {
    "meetingId": "m_…",
    "contact": {
      "id": "…",
      "externalId": "ext_contact_42",
      "phoneNumber": "+14155550123"
    },
    "scheduledAt": "2026-05-30T16:00:00.000Z",
    "status": "scheduled",
    "title": "Demo with Babbage Engines",
    "duration": 30,
    "createdAt": "2026-05-23T15:10:00.000Z"
  }
}

`recording.ready`

The recording has been processed and is downloadable. Required: data.recordingId, data.callId, data.url, data.createdAt

string

required

Signed URL to the recording.

string

Audio container, for example mp3 or wav.

number

Duration in seconds.

string

Plain-text transcript, when available.

{
  "event": "recording.ready",
  "eventId": "evt_…",
  "occurredAt": "2026-05-23T14:43:00.000Z",
  "workspaceId": "org_…",
  "integrationId": "ci_…",
  "data": {
    "recordingId": "r_…",
    "callId": "f3b1…",
    "url": "https://recordings.ringee.app/…",
    "format": "mp3",
    "durationSec": 142,
    "createdAt": "2026-05-23T14:43:00.000Z"
  }
}

Attach the recording to the activity matched by callId, and protect the URL behind your CRM’s existing access policies. Never expose recordings across organizations.

`dnc.created`

A phone number or contact was added to the Do Not Call list. Required: data.phoneNumber, data.createdAt

string

Free-text reason.

string

Channel that triggered the addition.

object

Contact reference.

object

User reference.

{
  "event": "dnc.created",
  "eventId": "evt_…",
  "occurredAt": "2026-05-23T15:30:00.000Z",
  "workspaceId": "org_…",
  "integrationId": "ci_…",
  "data": {
    "phoneNumber": "+14155550123",
    "createdAt": "2026-05-23T15:30:00.000Z"
  }
}

On receipt, mark the contact as Do Not Call and disable your Call with Ringee button for it.

`test.ping`

Sent when you click Test webhook. Use it to validate signature verification end to end.

{
  "event": "test.ping",
  "eventId": "evt_test_1747999938000",
  "occurredAt": "2026-05-23T14:00:00.000Z",
  "workspaceId": "org_…",
  "integrationId": "ci_…",
  "data": { "message": "Hello from Ringee custom integrations." }
}

Respond 200 with:

{ "received": true, "event": "test.ping" }

Machine-readable spec

The same definitions are available at runtime:

GET /api/integrations/custom/event-specs

It returns each event’s requiredFields, optionalFields, examplePayload and notes — useful for generating types or validating your handler in CI.

Get Started

CRM to Ringee

Ringee to CRM

Guides

Shared entity references

`call.completed`

`call.outcome.updated`

`call.missed`

`call.failed`

`note.created`

`callback.created`

`meeting.created`

`recording.ready`

`dnc.created`

`test.ping`

Machine-readable spec

​Shared entity references

​call.completed

​call.outcome.updated

​call.missed

​call.failed

​note.created

​callback.created

​meeting.created

​recording.ready

​dnc.created

​test.ping

​Machine-readable spec

Shared entity references

`call.completed`

`call.outcome.updated`

`call.missed`

`call.failed`

`note.created`

`callback.created`

`meeting.created`

`recording.ready`

`dnc.created`

`test.ping`

Machine-readable spec