Skip to main content
PUT
Update a webhook

Authorizations

X-API-KEY
string
header
required

Body

application/json
id
string
required

Webhook id

Example:

"67b14aa9-daac-800e-83bf-f1b44468d1d9"

url
string

Webhook URL

Example:

"https://myserver.com/webhook"

name
string

Webhook name

Example:

"Payment Webhook"

events
enum<string>[]

List of events to subscribe

Available options:
charge.pending,
charge.processing,
charge.paid,
charge.received,
charge.expired,
subscription.authorized,
subscription.rejected,
subscription.charge.paid,
subscription.charge.failed
Example:
status
enum<string>

Webhook status

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

Response

200 - application/json

Webhook updated successfully

id
string
required

Webhook id

Example:

"67b14aa9-daac-800e-83bf-f1b44468d1d9"

url
string
required

Webhook URL

Example:

"https://example.com/webhook"

name
string
required

Webhook name

Example:

"Payment Webhook"

companyId
string
required

Company id

Example:

"67b14aa9-daac-800e-83bf-f1b44468d1d9"

status
enum<string>
required

Webhook status

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

events
enum<string>[]
required

List of subscribed events

Available options:
charge.pending,
charge.processing,
charge.paid,
charge.received,
charge.expired,
subscription.authorized,
subscription.rejected,
subscription.charge.paid,
subscription.charge.failed
Example:
createdAt
string<date-time>
required

Creation date

Example:

"2024-02-15T12:34:56Z"

updatedAt
string<date-time>
required

Update date

Example:

"2024-02-16T12:34:56Z"