Webhooks configuration
  • 19 Jun 2024
  • 1 Minute to read

Webhooks configuration


Article summary

What is a webhook? 

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

Configuring the webhook in the merchant portal

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

Enter the portal in the Developers menu. Then to configure an endpoint, select the Add Endpoint option.

OrkestaPay (8)(1)


You must follow the steps below:

  1. Add your endpoint URL, optionally, you can attach a description of your endpoint.

  2. Select the event that will be notified to the endpoint in the Subscribe to events option, you must choose at least one event to report.

OrkestaPay (9)(2)

NOTE

To be notified about the status of paid orders, you will need to select the order.update event and check its status "COMPLETED"

Once registered, you will be able to test the webhook in the Testing tab with the available events, in which a notification with test data will be sent.

OrkestaPay (10)(2)

Logs

The Logs section lists the notifications that have been sent to the configured webhook.

OrkestaPay (6)(6)


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

OrkestaPay (7)(4)

Tests

It is worth mentioning that the URL that is configured in the webhook must be exposed to the internet in order to notify you of the messages.

We recommend using the ngrok tool for your local tests.



Was this article helpful?