LogoLogo
  • About
  • Quick Start
  • API reference
    • Workspace
      • Dependencies
      • Copy
      • Property definitions
        • Reorder
      • Property instances
        • Reorder
        • Lock
        • Unlock
      • Blocks
      • Comments
        • Parent
      • Data Sinks
    • Webhooks
      • Rotate secret
    • Cloud storage
      • Redirect
      • Thumbnail
      • Upload complete
      • Retry conversion
      • Download
      • Upload link
      • Version list
      • Metadata
Powered by GitBook
On this page

Was this helpful?

  1. API reference

Webhooks

PreviousData SinksNextRotate secret

Was this helpful?

get
Path parameters
idstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/webhooks/{id}'
200
403
{
  "id": "text",
  "label": "text",
  "url": "text",
  "signingSecret": "text",
  "headers": [
    "text"
  ],
  "dataEvents": [
    "text"
  ],
  "oauthConnection": {},
  "createdBy": "text",
  "createdAt": "2025-04-03T06:12:24.899Z",
  "updatedAt": "2025-04-03T06:12:24.899Z"
}

Returns a single webhook.

delete
Path parameters
idstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/v1/webhooks/{id}'
200
403
{
  "id": "text",
  "label": "text",
  "url": "text",
  "signingSecret": "text",
  "headers": [
    "text"
  ],
  "dataEvents": [
    "text"
  ],
  "oauthConnection": {},
  "createdBy": "text",
  "createdAt": "2025-04-03T06:12:24.899Z",
  "updatedAt": "2025-04-03T06:12:24.899Z"
}

The webhook has been successfully deleted.

  • GET/v1/webhooks
  • POST/v1/webhooks
  • GET/v1/webhooks/{id}
  • DELETE/v1/webhooks/{id}
  • PATCH/v1/webhooks/{id}
get
Query parameters
takenumber · min: 1 · default: 10optional

Number of records to take

Example: 10
skipnumber · default: 0optional

Number of records to skip

Example: 0
sortOrderstring · enum · default: "DESC"optional

Order by which to sort records

Example: DESC
Available options:
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
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/v1/webhooks'
200
403
[
  {
    "id": "text",
    "label": "text",
    "url": "text",
    "signingSecret": "text",
    "headers": [
      "text"
    ],
    "dataEvents": [
      "text"
    ],
    "oauthConnection": {},
    "createdBy": "text",
    "createdAt": "2025-04-03T06:12:24.899Z",
    "updatedAt": "2025-04-03T06:12:24.899Z"
  }
]

Returns an array of webhooks.

post
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Body
objectoptional
Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/v1/webhooks' \
  --header 'Content-Type: application/json' \
  --data '{}'
201
403
No body

The record has been successfully created.

patch
Path parameters
idstringrequired
Header parameters
x-api-keystringoptional

An x-api-key required for authentication

Body
objectoptional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url '/v1/webhooks/{id}' \
  --header 'Content-Type: application/json' \
  --data '{}'
200
403
{
  "id": "text",
  "label": "text",
  "url": "text",
  "signingSecret": "text",
  "headers": [
    "text"
  ],
  "dataEvents": [
    "text"
  ],
  "oauthConnection": {},
  "createdBy": "text",
  "createdAt": "2025-04-03T06:12:24.899Z",
  "updatedAt": "2025-04-03T06:12:24.899Z"
}

The webhook has been successfully updated.