Setup

Set Terminal Webhook URL:

In order to set the Webhook URL for the terminal, use the following endpoint, where id is the Terminal ID.

The endpoint will return a JSON object with the following structure:

{
  "url": "string",
  "signingSecret": "string"
}

• url: The Webhook URL set for the terminal.

• signingSecret: A secret key generated by the API, utilized for verifying the authenticity of the webhook sender. Refer to the "Webhook Signatures" section for details on how to use this secret.

PUT/Terminals/{id}/set-webhook-url

Authorization

oauth2

Path parameters

id*string

Header parameters

Body

application/jsontext/jsonapplication/*+json

url*string

Response

200401403

Success

Body

text/plainapplication/jsontext/json

urlnullable string

signingSecretnullable string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/Terminals/{id}/set-webhook-url', {
    method: 'PUT',
    headers: {
      "api-version": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text"
    }),
});
const data = await response.json();

Response

200

{
  "url": "text",
  "signingSecret": "text"
}

Delete Terminal Webhook URL:

In order to delete the Webhook URL for the terminal, use the endpoint below, where id is the Terminal ID:

PUT/Terminals/{id}/delete-webhook-url

Authorization

oauth2

Path parameters

id*string

Header parameters

Response

200401403

Success

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/Terminals/{id}/delete-webhook-url', {
    method: 'PUT',
    headers: {
      "api-version": "text"
    },
});
const data = await response.json();