Skip to main content

Webhooks

When you create an Order you can specify multiple webhook URLs. Anytime a webhook even happens, we will send the provided webhook URL a POST request with the body below.

Security Considerations​

You can securitize your webhook endpoints in two ways.

Firewall​

Block all requests that do not come from our fixed IP addresses:

  • 161.35.210.255
  • 159.223.23.119
  • 104.248.244.118

Secret Validation​

You can pass any secret in the Order's meta property and you can validate it when you read the webhook requests to ensure the requests comes from Orchestrapay.

Payload​

Order Status Updates​

Everytime the status of the order changes, the following webhook is sent (see Order Lifecycle)

{
    "event": "order.status.updated",
    "order": {
        "status": 
        // ... the rest of the Order Object
    }
}

Returns Status Updates​

Everytime the status of a refud changs, the following webhook is sent (see Returns Lifecycle)

{
    "event": "returns.status.updated",
    "refund": {
        "status": "pending.pickup",
        // ... the rest of the Return Object
    }
}