ForjioHuudisIdentityPlugipayPaymentsStorlaunchE-commerceFulkrumaFulfillmentRiplloMarketingDeplloThis product
Depllo Docs
⌘K

Webhook endpoints

Generated from Depllo's own code: every route in this area, what it takes and how to call it.

Method Path What it does
GET /api/v1/webhook-endpoints List the workspace's webhook endpoints, newest first.
POST /api/v1/webhook-endpoints Register a webhook endpoint.
DELETE /api/v1/webhook-endpoints/{id} Delete a webhook endpoint and its delivery log.
GET /api/v1/webhook-endpoints/{id} Get a webhook endpoint.
PATCH /api/v1/webhook-endpoints/{id} Update a webhook endpoint. active: false pauses it (its queued deliveries become failed); active: true re-enables it — also after Depllo switched it off for failing — and clears its failure streak
GET /api/v1/webhook-endpoints/event-types The event types an endpoint can subscribe to, with what each reports.

List the workspace's webhook endpoints, newest first.

GET /api/v1/webhook-endpoints

Example

curl -X GET "https://depllo.forjio.com/api/v1/webhook-endpoints" \
  -H "Authorization: Bearer sk_live_<your API key>"

Register a webhook endpoint.

POST /api/v1/webhook-endpoints

Register a webhook endpoint. The response is the only time its signing secret is returned. The URL must be https and must not point at a private, loopback or link-local address. events takes "" (the default), event types ("depllo.pipeline.finished.v1") and prefixes ("depllo.job.").

Body

Field Type Required Notes
url string (uri) yes max length 2000
events array of string no
description string no max length 500

Example

curl -X POST "https://depllo.forjio.com/api/v1/webhook-endpoints" \
  -H "Authorization: Bearer sk_live_<your API key>" \
  -H "Content-Type: application/json" \
  -d '{"url":"…","events":[],"description":"…"}'

Delete a webhook endpoint and its delivery log.

DELETE /api/v1/webhook-endpoints/{id}

Path parameters

Name Type Required Notes
id string yes

Example

curl -X DELETE "https://depllo.forjio.com/api/v1/webhook-endpoints/:id" \
  -H "Authorization: Bearer sk_live_<your API key>"

Get a webhook endpoint.

GET /api/v1/webhook-endpoints/{id}

Path parameters

Name Type Required Notes
id string yes

Example

curl -X GET "https://depllo.forjio.com/api/v1/webhook-endpoints/:id" \
  -H "Authorization: Bearer sk_live_<your API key>"

Update a webhook endpoint. active: false pauses it (its queued deliveries become failed); active: true re-enables it — also after Depllo switched it off for failing — and clears its failure streak

PATCH /api/v1/webhook-endpoints/{id}

Update a webhook endpoint. active: false pauses it (its queued deliveries become failed); active: true re-enables it — also after Depllo switched it off for failing — and clears its failure streak. A new url goes through the same checks as on register; the signing secret stays the same.

Path parameters

Name Type Required Notes
id string yes

Body

Field Type Required Notes
url string (uri) no max length 2000
events array of string no
description string no max length 500; may be null
active boolean no

Example

curl -X PATCH "https://depllo.forjio.com/api/v1/webhook-endpoints/:id" \
  -H "Authorization: Bearer sk_live_<your API key>" \
  -H "Content-Type: application/json" \
  -d '{"url":"…","events":[],"description":"…","active":false}'

The event types an endpoint can subscribe to, with what each reports.

GET /api/v1/webhook-endpoints/event-types

Example

curl -X GET "https://depllo.forjio.com/api/v1/webhook-endpoints/event-types" \
  -H "Authorization: Bearer sk_live_<your API key>"