Webhooks

get

Query parameters

takenumber · min: 1Optional

Number of records to take

Default: 10Example: 10

skipnumberOptional

Number of records to skip

Default: 0Example: 0

sortOrderstring · enumOptional

Order by which to sort records

Default: DESCExample: DESCPossible values:

searchstringOptional

Text to search

Example: example search

sortedBystringOptional

Field by which to sort records

Example: createdAt

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

Responses

200

Returns an array of webhooks.

application/json

403

Forbidden.

get

HTTPcURLJavaScriptPython

GET /v1/webhooks HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "label": "text",
    "url": "text",
    "signingSecret": "text",
    "headers": [
      "text"
    ],
    "dataEvents": [
      "text"
    ],
    "oauthConnection": {},
    "createdBy": "text",
    "createdAt": "2025-08-08T01:00:57.669Z",
    "updatedAt": "2025-08-08T01:00:57.669Z"
  }
]

post

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

Body

objectOptional

Responses

201

The record has been successfully created.

403

Forbidden.

post

HTTPcURLJavaScriptPython

POST /v1/webhooks HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

No content

get

Path parameters

idstringRequired

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

Responses

200

Returns a single webhook.

application/json

403

Forbidden.

get

HTTPcURLJavaScriptPython

GET /v1/webhooks/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "label": "text",
  "url": "text",
  "signingSecret": "text",
  "headers": [
    "text"
  ],
  "dataEvents": [
    "text"
  ],
  "oauthConnection": {},
  "createdBy": "text",
  "createdAt": "2025-08-08T01:00:57.669Z",
  "updatedAt": "2025-08-08T01:00:57.669Z"
}

delete

Path parameters

idstringRequired

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

Responses

200

The webhook has been successfully deleted.

application/json

403

Forbidden.

delete

HTTPcURLJavaScriptPython

DELETE /v1/webhooks/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "label": "text",
  "url": "text",
  "signingSecret": "text",
  "headers": [
    "text"
  ],
  "dataEvents": [
    "text"
  ],
  "oauthConnection": {},
  "createdBy": "text",
  "createdAt": "2025-08-08T01:00:57.669Z",
  "updatedAt": "2025-08-08T01:00:57.669Z"
}

patch

Path parameters

idstringRequired

Header parameters

x-api-keystringOptional

An x-api-key required for authentication

Body

objectOptional

Responses

200

The webhook has been successfully updated.

application/json

403

Forbidden.

patch

HTTPcURLJavaScriptPython

PATCH /v1/webhooks/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "id": "text",
  "label": "text",
  "url": "text",
  "signingSecret": "text",
  "headers": [
    "text"
  ],
  "dataEvents": [
    "text"
  ],
  "oauthConnection": {},
  "createdBy": "text",
  "createdAt": "2025-08-08T01:00:57.669Z",
  "updatedAt": "2025-08-08T01:00:57.669Z"
}