Update a webhook subscription

Update a webhook subscription

Path Parameters

event string required

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

The event to update

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

• 200
• 400
• 401
• 403

---

Successfully updated the webhook subscription

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

Loading...