Webhooks Configuration

How to configure webhooks

Make an API call to the Webhook settings endpoint (PUT /3.1/webhook_subscriptions/{topic}).
Replace {topic} with the topic you want to subscribe to (i.e. the event you want to be notified about), for example subscriptionReadyForPaymentAuthorisation. A topic identifies what event has occurred in the Cleeng system.

See the related sections for the available webhook topics.
Provide a list of endpoints to which notifications should be delivered.
(Optional) Apply the webhook filtering logic - filtering by paymentMethodId. This allows you to differentiate transactions coming from the respective connectors.
(Recommended) Enable webhook verification. It is optional, but we recommend enabling it for security purposes.

NOTE: You have to repeat the configuration steps for each required topic.

🚧
Warning
Be careful not to override the webhooks you have already subscribed to (see the example for more details).
The PUT method creates a new resource or replaces a representation of the target resource with the request message payload.

🚧
Important
Subscribing to the webhooks and making filtering setup is required for recurring payments with PayPal to work properly.

Check webhook topics you subscribed to

You can check the topics you subscribed to with the List webhook subscriptions endpoint (GET /3.1/webhook_subscriptions).