Webhooks Integration

Webhooks allow your server to automatically receive notifications about events in our system. Instead of periodically polling the API, you configure one endpoint and we send you an HTTP request for each important event.

To connect webhooks, you need:

Create an HTTPS endpoint that accepts JSON requests.
Send us the URL of this endpoint.
Choose which events you want to receive.
Accept and test webhook.

How it works in general

An event occurs in our system (for example, a payment is created or its status has changed).
We form a webhook notification in the form of an HTTP POST request with a JSON host.
We send a request to your endpoint.
Your server handles the request and responds with 2xx (usually 200) if it is successful.

Webhooks use a common format (contract) for all event types. Only the type field value and the data object content are different.

Step 1: Create endpoint to receive webhooks

First you need to prepare an endpoint on your system that will accept webhook requests.

Endpoint requirements:

Must accept HTTP POST requests.
Must be accessible via HTTPS.
If the request is successfully processed, the HTTP code must be returned from the 2xx range (for example, 200 OK).
It is desirable to reply as soon as possible (the processing can be put in an asynchronous queue).

Recommended processing approach:

Must accept HTTP POST requests.
Write event to log/database.
Asynchronous processing (queue, background tasks, etc.).
Return response 200 OK if the request is accepted.

You can implement this endpoint on any stack that you use (Node.js, PHP, Python, Java, Go, etc).

Step 2: Give us your endpoint URL

First you need to prepare an endpoint on your system that will accept webhook requests.

Endpoint requirements:

Must accept HTTP POST requests.
Must be accessible via HTTPS.
If the request is successfully processed, the HTTP code must be returned from the 2xx range (for example, 200 OK).
It is desirable to reply as soon as possible (the processing can be put in an asynchronous queue).

Endpoint requirements:

First you need to prepare an endpoint on your system that will accept webhook requests.

Must accept HTTP POST requests.
Must be accessible via HTTPS.
If the request is successfully processed, the HTTP code must be returned from the 2xx range (for example, 200 OK).
It is desirable to reply as soon as possible (the processing can be put in an asynchronous queue).

Step 3: Select the events you want to receive

We support a common webhook-notification format for all events. The specific event type is defined by the type field in the JSON body.

You can select one or more event types. Once connected, we will send you webhooks only for the selected events.

What to do:

View the list of available events (see below)
Determine which events you need.
Send us a list of event identifiers.

For example:

I would like to receive subscription_manual_chargeback, subscription_event_refund, subscription_user_create

You can change the list of events at any time - just send us a new list.

Step 4: We activate webhooks and send a test request

After you have:

configured the endpoint,
gave us the URL,
selected and agreed the list of events,

we connect your endpoint and start sending webhooks.

At the connection stage we can send a test webhook to make sure that:

your endpoint is accessible over the network,
requests are successfully accepted,
you correctly process JSON and return the 2xx response.

What you should do:

Check the server logs and make sure that the test webhook has been received.
Make sure that the processing is done correctly (for example, these events are saved in your system).
If necessary, adjust the processor.