🚧

Upgrade to the latest version

These docs are for version 2023-12-01. We encourage you to upgrade to version 2024-10-16 to access new features. Please see the changelog for more information.

How to configure webhooks

To configure a webhook, head on over to the Webhooks tab in the Rainforest Platform Portal.

Start by adding an endpoint. You will be prompted to enter the URL to receive the webhooks and choose which events you wish to trigger.

Read a webhook payload

Every webhook payload will include a data and event_type field. Your endpoint must check the event_type to parse the data payload. The event_type includes the Rainforest resource that represents the data payload and the event that occurred on the resource.

{
    "data": {
        ...
    },
    "event_type": "payin.processing"
}

Validating webhooks

To ensure the webhooks you receive from Rainforest are valid, we sign each request with a signing key, unique to your account. It's important that you verify their authenticity. Checkout the verify webhooks recipe above for a detailed walkthrough.

Webhook source IP addresses

All webhooks are sent from the following IP addresses:

44.228.126.217
50.112.21.217
52.24.126.164
54.148.139.208

Retry behavior

In order to give your application the best chance at ingesting webhooks from Rainforest, we will attempt to deliver a webhook until a successful response is received. These attempts will perform an exponential backoff over a period of approximately 28 hours until either a successful response is received, or all attempts are exhausted.

A successful response is denoted by any 2XX HTTP status code. If a particular endpoint has activity with no 2XX responses for a week the endpoint will automatically be disabled.