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
- 204
- 400
- 401
- 403
Successfully tested the webhook subscription
Invalid request body
application/json
Schema
Example (from schema)
Schema
errors object[]
{
"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
POST /webhooks/:event/test
Authorization
name: x-rinkel-api-keytype: apiKeyin: header
Request
Request
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"
}'
nodejs / axios
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"
}'
php / axios
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"
}'
python / requests
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"
}'
ruby / 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"
}'
java / unirest
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"
}'