Webhooks configuration

What is a webhook? 

A webhook is an automated message sent to an external application when an event occurs. Technically, a webhook is an HTTP callback or an HTTP POST request generated by the notification of an event.

Configuring the webhook in the merchant portal

To set up a webhook, first, create an endpoint where notifications will be sent. This endpoint should be a URL that accepts HTTP POST requests.

Go to the Developers menu in the portal, select the Webhooks tab, and then click on Add Endpoint.

Follow these steps:

1. Add your endpoint URL and optionally a description.

2. Select the event to notify the endpoint in the Subscribe to events option. You must choose at least one event to notify.

Once registered, you can test the webhook in the Testing tab with available events, which will send a notification with test data.

To verify the messages that OrkestaPay sends to the specified webhook, you must use the Webhook Signing Secret that we provide and follow our Message verification guide.

Logs

In the Logs section, the notifications sent to the configured webhook are listed, detailing the message, notification attempts, and responses.

Each notification displays the message details, the notification's attempts, and the details of the responses for each notification.

Tests

The configured webhook URL must be exposed to the internet to receive messages. We recommend using ngrok for local testing.