Skip to main content
POST
/
urls
/
test
Send a test webhook to verify URL configuration
curl --request POST \
  --url https://webhooks.platform.arb.inc/urls/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://api.example.com/webhooks/arb-platform"
}
'
{
  "statusCode": 200,
  "body": "{\"status\":\"success\",\"message\":\"Webhook received\"}"
}

Authorizations

​
Authorization
string
header
required

access token

Body

application/json
​
url
string<uri>
required

The registered webhook URL to test

Example:

"https://api.example.com/webhooks/arb-platform"

Response

Test webhook was sent successfully and a response was received

​
statusCode
integer

HTTP status code returned by the webhook endpoint

Example:

200

​
body
string

Raw response body returned by the webhook endpoint

Example:

"{\"status\":\"success\",\"message\":\"Webhook received\"}"