Test Webhook

POST /v2/webhooks/test/{webhook_nanoid}

Try it

Test Webhook

cURL

curl --request POST \
  --url https://b2b-api.dev-riseworks.io/v2/webhooks/test/{webhook_nanoid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "withdraw_account.duplicated_detected",
  "version": 1
}
'

202

{
  "success": true,
  "data": {
    "delivery_nanoid": "<string>",
    "message": "<string>",
    "test_payload": {},
    "version": 123
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

webhook_nanoid · string · required

Unique identifier of the Webhook Endpoint.

Required string length: 15

Body

application/json

event_type · enum<string> · required

Available options: withdraw_account.duplicated_detected, invite.accepted, payment.sent, deposit.received, payment.group.created

version · integer · default: 1

Webhook payload major version (defaults to 1)

Required range: 1 <= x <= 10

Response

202

application/json

Default Response

success · enum<boolean> · required

Available options: true, false

data · object · required

Show child attributes

data. delivery_nanoid · string · required

Unique identifier of the Webhook Delivery.

Required string length: 15

data. message · string · required

data. test_payload · object

Generated test payload for the webhook

Show child attributes

data.test_payload. {key} · any

data. version · number

Major version of the webhook payload used