Webhooks

Get, create and delete webhooks. Use these to build third-party integrations.

PreviousCampaigns NextStorefront

Was this helpful?

Returns all webhooks for a given merchant. Merchant is pulled from the public API key for security reasons.

get

/v2.0/admin/webhooks

Header parameters

X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2.0/admin/webhooks' \
  --header 'X-Inveterate-Api-Key: text'

200

400

500

{
  "message": "text",
  "data": {}
}

Returned upon successful direct action to our database. Action is immediate.

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`

post

/v2.0/admin/webhooks

Header parameters

X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v2.0/admin/webhooks' \
  --header 'X-Inveterate-Api-Key: text'

201

400

500

{
  "message": "text",
  "data": {}
}

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.

Deletes a webhook for a given merchant. Merchant is pulled from the public API key for security reasons. The effects of this method are both immediate (data deleted from webhooks database) and eventual (request against backend service to confirm webhook deletion).

delete

/v2.0/admin/webhooks

Header parameters

X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v2.0/admin/webhooks' \
  --header 'X-Inveterate-Api-Key: text'

201

400

500

{
  "message": "text",
  "data": {}
}

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.