AFafriex
Sandbox helpers

Trigger a test webhook (sandbox-only)

Fires a real signed webhook to the business's configured callback URL using a real entity (customer, payment method, or transaction) as the payload. Useful for testing webhook handlers in sandbox without manufacturing the underlying activity. This endpoint is only available in the sandbox environment and will return a 403 Forbidden response in production. The business must have a webhook callback URL configured, or the request is rejected with 400.

post/api/v1/webhooks/trigger

Request

Request body

event'CUSTOMER.CREATED' | 'CUSTOMER.UPDATED' | 'CUSTOMER.DELETED' | 'PAYMENT_METHOD.CREATED' | 'PAYMENT_METHOD.UPDATED' | 'PAYMENT_METHOD.DELETED' | 'TRANSACTION.CREATED' | 'TRANSACTION.UPDATED' | 'POOL_DEPOSIT_REQUEST.REJECTED' required

The webhook event identifier.

entityIdstring required

The identifier of the entity to send in the webhook payload. Must be the 24-character hexadecimal id of the relevant customer, payment method, or transaction (the id returned when it was created).

Example request

{
  "entityId": "69528240ba52c13b669fb239"
}

Response

Webhook triggered successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.