Skip to main content

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

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

POST /webhooks/:event/test

Authorization

name: x-rinkel-api-keytype: apiKeyin: header

Request

Base URL
https://api.rinkel.com/v1
apiKeyAuth
event — path required
Body required
{
"url": "https://example.com/webhook",
"contentType": "application/json"
}
curl / cURL
curl -L -X POST 'https://api.rinkel.com/v1/webhooks/:event/test' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
"url": "https://example.com/webhook",
"contentType": "application/json"
}'