Finished Order Webhook

Relograde offers a Webhook feature that allows users to receive a notification when an order reaches the finished status. To enable WebHook notifications, create a new API key or edit your existing API key at Relograde console and enter your own endpoint.

As soon as an order has been confirmed and reaches the finished status, our system will send a POST request with a content type application/json body to your endpoint. The response of your endpoint will be ignored.

Example body

{
  "event": "ORDER_FINISHED",
  "state": "sandbox",
  "apiKeyDescription": "Test key",
  "data": {
    "trx": "RELO0TFQK8FXQXSPURM",
    "reference": "test reference"
  }
}

Fields

Field name	Field type	Nullable	Field description
event	String	Yes	Event type
state	String	Yes	Environment
apiKeyDescription	String	No	Description of API key
data	Object	Yes	Data object

ORDER_FINISHED Data

Field name	Field type	Nullable	Field description
trx	String	No	Trx of the order
reference	String	Yes	Returns the reference of the order, when this is set during the creation of the order.

Notes

note

• Our API supports only the ORDER_FINISHED event. More events might be added in the future
• The notification is very simple. It is suggested you call the find-order endpoint to get details about the order.
• Relograde webhook notifications will be sent by the following ip: 18.195.134.217.