Skip to content

Register a webhook

Request

Generates a security token and places an entry with the token and the callback URL in our backend. The token is used to verify that the request is coming from Inveterate within your app, when the callback URL is triggered. Ensure that you save the token.

The callback URL will be triggered when one of the following events occurs:

merchant.updated merchant.reinstall customer.created customer.updated customer.credits.updated customer.ordered customer.cancellation_requested customer.confirmed_cancellation

Security
api_key
curl -i -X POST \
  https://public.inveterateapi.com/v2.0/admin/webhooks \
  -H 'X-Inveterate-Api-Key: YOUR_API_KEY_HERE'

Responses

Returned upon successful request made to our backend. Requests that return this code may take a small amount of time after successful API return to fully update.

Bodyapplication/json
messagestringrequired

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

dataobjectrequired

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

Response
{
  "message": "Request sent successfully",
  "data": {
    "id": 1,
    "name": "John Doe"
  }
}