Test a webhook url

Can be used to send example data to a webhook url to test if it works. Using this endpoint will avoid CORS issues on the client side.

Path Parameters

event string required

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

The event to test

application/json

Request Body required

url uri

The url to send the test webhook to

contentType string

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

The content type to send the test webhook with

Responses

Successfully tested the webhook subscription

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"
    }
  ]
}

Test a webhook url​

Test a webhook url