Skip to content

Get webhook subscription

GET
/api/webhooks/subscription/{id}
Code sample: Shell / cURL
curl --request GET \
--url https://api.ztlpay.io/api/webhooks/subscription/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'
id
required
string format: uuid

Subscription belonging to the authenticated partner.

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

Subscription was not found.