Overview

Get, create, update and delete webhook subscriptions. Use these to build third-party integrations.

get

Returns all webhook subscriptions for the merchant

Header parameters
X-Inveterate-Api-KeystringRequired

Your private Inveterate API key.

Responses
chevron-right
200

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

application/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.

get
/v2.0/admin/webhook-subscriptions
post

Creates a new webhook subscription for the merchant

Header parameters
X-Inveterate-Api-KeystringRequired

Your private Inveterate API key.

Body
topicstring · enumRequired

The subscription topic (will be used as sort key).

Example: customer.joined.paid_tierPossible values:
callbackUrlstringRequired

The callback URL that will be called when one of the webhooks is triggered.

namestringRequired

The subscription name.

Responses
post
/v2.0/admin/webhook-subscriptions
put

Updates an existing webhook subscription configuration

Header parameters
X-Inveterate-Api-KeystringRequired

Your private Inveterate API key.

Body
topicstring · enumRequired

The subscription topic to update.

Example: customer.joined.paid_tierPossible values:
callbackUrlstringOptional

The callback URL that will be called when one of the webhooks is triggered.

namestringOptional

The subscription name.

idstringRequired

The subscription ID.

Responses
chevron-right
200

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

application/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.

put
/v2.0/admin/webhook-subscriptions
delete

Removes an existing webhook subscription

Header parameters
X-Inveterate-Api-KeystringRequired

Your private Inveterate API key.

Body
topicstring · enumRequired

The subscription topic to delete

Example: customer.joined.paid_tierPossible values:
idstringRequired

The subscription ID.

Responses
delete
/v2.0/admin/webhook-subscriptions

Last updated

Was this helpful?