Set or rotate bearer token

POST

/api/webhooks/subscription/{id}/rotate-bearer-token

Code sample: Shell / cURL

curl --request POST \
  --url https://api.ztlpay.io/api/webhooks/subscription/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rotate-bearer-token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "bearerToken": "example" }'

• Production environment
• Sandbox environment for testing

Already queued deliveries retain the previous bearer token. Allow an overlap period in your receiver while those deliveries finish.

Authorizations

• OAuth2Sandbox
  api://ac0d1aea-5e3a-463f-9dd1-194898ee5820/.default
• OAuth2Production
  api://1f115cad-5576-4db9-a7f9-8921c47a86e4/.default

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

bearerToken

required

Non-blank token value without the Bearer prefix. This endpoint cannot remove a configured token.

string

>= 1 characters

Example^generated

{
  "bearerToken": "example"
}

Responses

200

Updated subscription. The bearer token is not returned.

Media typeapplication/json

object

id

required

string format: uuid

targetUrl

required

string format: uri

enabled

required

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

eventTypes

required

Array<string>

unique items

Allowed values: PAYMENT_STATUS PAYMENT_STATUS_UNSIGNED PAYMENT_STATUS_IN_PROGRESS PAYMENT_STATUS_REJECTED PAYMENT_STATUS_COMPLETED PAYMENT_STATUS_CANCELLED PAYMENT_STATUS_CUSTOMER_ACTION_REQUIRED

hasBearerToken

required

boolean

Example

{
  "eventTypes": [
    "PAYMENT_STATUS"
  ]
}

400

Bearer token must not be blank.

404

Subscription was not found.