Skip to main content
PATCH
/
v1
/
webhooks
/
{id}
Update webhook
curl --request PATCH \
  --url https://api.quentli.com/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "data": {
      "url": "<string>",
      "description": "<string>",
      "secret": "<string>",
      "enabledEvents": []
    }
  }
}
'
{
  "id": "w_1234567890abcdefghij",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "status": "ENABLED",
  "organizationId": "org_1234567890abcdefghij",
  "description": null,
  "enabledEvents": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "webhookId": "w_1234567890abcdefghij"
    }
  ],
  "deletedAt": null,
  "deletedById": null
}

Authorizations

​
Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Path Parameters

​
id
string
required

Identifier of the webhook.

Body

application/json

Request body for updating a webhook.

​
input
object
required

Response

Webhook updated

Webhook endpoint configured by the organization.

​
id
string
required

Unique identifier of the webhook.

Example:

"w_1234567890abcdefghij"

​
createdAt
required

When the webhook was created.

​
updatedAt
required

When the webhook was last updated.

​
url
string
required

Destination URL.

​
status
enum<string>
required

Current webhook status.

Available options:
ENABLED,
DISABLED,
BROKEN,
DELETED
Example:

"ENABLED"

​
organizationId
string
required

Owning organization identifier.

Example:

"org_1234567890abcdefghij"

​
description
string | null

Optional user-defined description.

Example:

null

​
enabledEvents
object[]

Event types currently enabled for this webhook.

​
deletedAt

When this webhook was deleted, if any.

Example:

null

​
deletedById
string | null

User who deleted this webhook.

Example:

null