Overview
Get, create, update and delete webhook subscriptions. Use these to build third-party integrations.
Returns all webhook subscriptions for the merchant
Your private Inveterate API key.
Returned upon successful direct action to our database. Action is immediate.
Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.
Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.
GET /v2.0/admin/webhook-subscriptions HTTP/1.1
Host:
X-Inveterate-Api-Key: text
Accept: */*
{
"message": "text",
"data": {}
}Creates a new webhook subscription for the merchant
Your private Inveterate API key.
The subscription topic (will be used as sort key).
customer.joined.paid_tierPossible values: The callback URL that will be called when one of the webhooks is triggered.
The subscription name.
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.
Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.
Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.
POST /v2.0/admin/webhook-subscriptions HTTP/1.1
Host:
X-Inveterate-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 72
{
"topic": "customer.joined.paid_tier",
"callbackUrl": "text",
"name": "text"
}{
"message": "text",
"data": {}
}Updates an existing webhook subscription configuration
Your private Inveterate API key.
The subscription topic to update.
customer.joined.paid_tierPossible values: The callback URL that will be called when one of the webhooks is triggered.
The subscription name.
The subscription ID.
Returned upon successful direct action to our database. Action is immediate.
Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.
Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.
PUT /v2.0/admin/webhook-subscriptions HTTP/1.1
Host:
X-Inveterate-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"topic": "customer.joined.paid_tier",
"callbackUrl": "text",
"name": "text",
"id": "text"
}{
"message": "text",
"data": {}
}Removes an existing webhook subscription
Your private Inveterate API key.
The subscription topic to delete
customer.joined.paid_tierPossible values: The subscription ID.
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.
Returned upon a malformed request. Check your API key, URL parameters, and body parameters when this error is returned. Generally, if you see this error, that also means NO action was taken on our backend.
Returned for all other errors. Generally these come from our backend. Some multipart functions may execute somewhat and then fail, causing some data to be updated.
DELETE /v2.0/admin/webhook-subscriptions HTTP/1.1
Host:
X-Inveterate-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 49
{
"topic": "customer.joined.paid_tier",
"id": "text"
}{
"message": "text",
"data": {}
}Last updated
Was this helpful?