v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
API and Webhooks

Send test webhooks

This endpoint sends a test webhook response for a selected event to the chosen URL. You will need to enable PERM_BUSINESS_GET_WEBHOOK_EVENT_TEST to use this endpoint.

get/v2/webhooks/{webhookId}/events/{event}/test

Path parameters

webhookIdinteger required

The ID of the webhook to test

Example:32
event'LODGEMENT_RECEIVED' | 'PAYMENT_RECEIVED' | 'PAYMENT_REQUEST_PAYMENT_RECEIVED' | 'ACCOUNT_CREATED' | 'CARD_CREATED' | 'CARD_AUTHORISATION' | 'CARD_SETTLEMENT' | 'PAYMENT_REQUEST_PAYMENT_AUTHORISED' | 'PIS_LODGEMENT_RECEIVED' required

The type of event to send. Currently only one event type is associated with each webhook, however this may change in future.

Example:CARD_AUTHORISATION

Response

Webhook test sent.