Subscribe to a webhook

Subscribe to a webhook

Path Parameters

event string required

Possible values: [incomingCall, outgoingCall, callStart, callEnd, callInsights]

The event to subscribe to

application/json

Request Body required

url uri required
contentType string required

Possible values: [application/json, application/x-www-form-urlencoded]

active boolean required
description string

Responses

• 201
• 400
• 401
• 403

---

Successfully subscribed to the webhook

application/json

Schema

Example (from schema)

---

Schema

data object
url uri
contentType string
Possible values: [application/json, application/x-www-form-urlencoded]
event string
Possible values: [incomingCall, outgoingCall, callStart, callEnd, callInsights]
active boolean
description string

{
  "data": {
    "url": "https://example.com/webhook",
    "contentType": "application/json",
    "event": "incomingCall",
    "active": true,
    "description": "My webhook"
  }
}

Invalid request body

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
code string
Human readable error code
message string
Human readable error message
detail string
Human readable error detail
]

{
  "errors": [
    {
      "code": "ERROR_CODE",
      "message": "An error occurred while calling the endpoint",
      "detail": "View more info at developers.rinkel.com"
    }
  ]
}

Unauthorized

Current plan does not include integrations

Callbacks

incomingCall

application/json

Request Body required

id string

The unique id of the call

datetime date-time

The time an incoming call was initiated

to string

The number that was called

from string

The number that called

Responses

• 200

---

Your server returns this code if it accepts the callback

outgoingCall

application/json

Request Body required

id string

The unique id of the call

datetime date-time

The time an outgoing call was initiated

to string

The number that was called

from string

The number that is calling

Responses

• 200

---

Your server returns this code if it accepts the callback

callStart

application/json

Request Body required

id string

The unique id of the call

datetime date-time

The time outgoing call was answered

answeredBy string

The email of the user that answered the call

choice string

Possible values: [``, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, *, #]

The choice made by the callee in the interactive menu

Responses

• 200

---

Your server returns this code if it accepts the callback

callEnd

application/json

Request Body required

id string

The unique id of the call

datetime date-time

The time an outgoing call was initiated

cause string

Possible values: [UNANSWERED, ANSWERED, BLACKLISTED, VOICEMAIL, CALLCENTER, OUTSIDE_OPERATION_TIMES]

The cause of the call ending

Responses

• 200

---

Your server returns this code if it accepts the callback

Loading...