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

200

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

application/json

400

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.

application/json

500

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.

application/json

get

HTTPcURLJavaScriptPython

GET /v2.0/admin/webhook-subscriptions HTTP/1.1
Host: 
X-Inveterate-Api-Key: text
Accept: */*

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

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

201

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.

application/json

400

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.

application/json

500

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.

application/json

post

HTTPcURLJavaScriptPython

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": {}
}

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

200

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

application/json

400

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.

application/json

500

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.

application/json

put

HTTPcURLJavaScriptPython

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": {}
}

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

201

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.

application/json

400

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.

application/json

500

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.

application/json

delete

HTTPcURLJavaScriptPython

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": {}
}