Webhooks

get

/v1/webhooks

Query parameters

takenumber · min: 1 · default: 10

Number of records to take

Example: 10

skipnumber · default: 0

Number of records to skip

Example: 0

sortOrderstring · enum · default: DESC

Order by which to sort records

Example: DESC

Options: ASC, DESC

searchstring

Text to search

Example: example search

sortedBystring

Field by which to sort records

Example: createdAt

Header parameters

x-api-keystring

An x-api-key required for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/webhooks'

200

403

200

[
  {
    "id": "text",
    "label": "text",
    "url": "text",
    "signingSecret": "text",
    "oauthConnection": {},
    "createdBy": "text",
    "createdAt": "2025-02-28T07:52:28.164Z",
    "updatedAt": "2025-02-28T07:52:28.164Z",
    "headers": [
      "text"
    ],
    "dataEvents": [
      "text"
    ]
  }
]

Returns an array of webhooks.

post

/v1/webhooks

Header parameters

x-api-keystring

An x-api-key required for authentication

Body

object

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/webhooks' \
  --header 'Content-Type: application/json' \
  --data '{}'

201

403

201

No body

The record has been successfully created.

get

/v1/webhooks/{id}

Path parameters

idstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/webhooks/{id}'

200

403

200

{
  "id": "text",
  "label": "text",
  "url": "text",
  "signingSecret": "text",
  "oauthConnection": {},
  "createdBy": "text",
  "createdAt": "2025-02-28T07:52:28.164Z",
  "updatedAt": "2025-02-28T07:52:28.164Z",
  "headers": [
    "text"
  ],
  "dataEvents": [
    "text"
  ]
}

Returns a single webhook.

delete

/v1/webhooks/{id}

Path parameters

idstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/webhooks/{id}'

200

403

200

{
  "id": "text",
  "label": "text",
  "url": "text",
  "signingSecret": "text",
  "oauthConnection": {},
  "createdBy": "text",
  "createdAt": "2025-02-28T07:52:28.164Z",
  "updatedAt": "2025-02-28T07:52:28.164Z",
  "headers": [
    "text"
  ],
  "dataEvents": [
    "text"
  ]
}

The webhook has been successfully deleted.

patch

/v1/webhooks/{id}

Path parameters

idstringrequired

Header parameters

x-api-keystring

An x-api-key required for authentication

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/v1/webhooks/{id}' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

403

200

{
  "id": "text",
  "label": "text",
  "url": "text",
  "signingSecret": "text",
  "oauthConnection": {},
  "createdBy": "text",
  "createdAt": "2025-02-28T07:52:28.164Z",
  "updatedAt": "2025-02-28T07:52:28.164Z",
  "headers": [
    "text"
  ],
  "dataEvents": [
    "text"
  ]
}

The webhook has been successfully updated.