Skip to content

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" }'

Already queued deliveries retain the previous bearer token. Allow an overlap period in your receiver while those deliveries finish. An accepted manual retry uses the current bearer token.

id
required
string format: uuid
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"
}

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 PAYROLL_STATUS PAYROLL_STATUS_UNSIGNED PAYROLL_STATUS_IN_PROGRESS PAYROLL_STATUS_REJECTED PAYROLL_STATUS_COMPLETED PAYROLL_STATUS_CANCELLED PAYROLL_STATUS_CUSTOMER_ACTION_REQUIRED ONBOARDING_STATUS ONBOARDING_STATUS_CREATED ONBOARDING_STATUS_AWAITING_CUSTOMER_ACTION ONBOARDING_STATUS_PROCESSING ONBOARDING_STATUS_MANUAL_HANDLING ONBOARDING_STATUS_ACCEPTED ONBOARDING_STATUS_REJECTED
hasBearerToken
required
boolean

Example

{
"eventTypes": [
"PAYMENT_STATUS"
]
}

Bearer token must not be blank.

Subscription was not found.