webhooks

Embed
Preview of the card
<a href="https://lucida.15-204-158-166.sslip.io/docs/ref-webhooks"><img src="https://lucida.15-204-158-166.sslip.io/docs/_api/public/orgs/af34862a-c837-4478-8335-0505efe40459/spaces/da916cd3-c0fc-4b63-b971-b3c13623daf3/pages/51ca7721-27ee-4eb6-916a-ef9e6383800c/social-card.svg?v=3e7ae33eec8b" alt="webhooks" width="600" height="315"></a>
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks

Parameters

project_idstringpathrequired
limitintegerquery
cursorstringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Page of Endpoint, newest first
404
POSThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks

Parameters

project_idstringpathrequired

Request body

application/json
enabledboolean
eventsstring[]
Event types; empty or omitted means all.
namestring
secretstring
Optional signing secret (min 16 characters); generated when omitted.
urlstringrequired
{
  "enabled": true,
  "events": [
    "string"
  ],
  "name": "string",
  "secret": "string",
  "url": "string"
}

Code samples

cURL
curl -X POST "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"events":["string"],"name":"string","secret":"string","url":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201
Example
{
  "created_at": "2024-01-01T00:00:00Z",
  "enabled": true,
  "events": [
    "string"
  ],
  "id": "string",
  "name": "string",
  "project_id": "string",
  "url": "string",
  "secret": "string"
}
Schema
created_atstringrequired
enabledbooleanrequired
eventsstring[]required
Subscribed event types; empty means all.
idstringrequired
namestringrequired
project_idstringrequired
urlstringrequired
secretstring
Shown once, only when the server generated it; stored envelope-encrypted.
400
403
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/event-types

Parameters

project_idstringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/event-types"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Array of event type strings
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/{id}

Parameters

project_idstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "created_at": "2024-01-01T00:00:00Z",
  "enabled": true,
  "events": [
    "string"
  ],
  "id": "string",
  "name": "string",
  "project_id": "string",
  "url": "string"
}
Schema
created_atstringrequired
enabledbooleanrequired
eventsstring[]required
Subscribed event types; empty means all.
idstringrequired
namestringrequired
project_idstringrequired
urlstringrequired
404
DELETEhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/{id}

Parameters

project_idstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X DELETE "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/{id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204
403
404
PATCHhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/{id}

Parameters

project_idstringpathrequired
idstringpathrequired

Request body

application/json
enabledboolean
eventsarray
namestring
urlstring
{
  "enabled": true,
  "events": [
    "string"
  ],
  "name": "string",
  "url": "string"
}

Code samples

cURL
curl -X PATCH "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/{id}" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"events":["string"],"name":"string","url":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200

Same as 200 · GET /v1/projects/{project_id}/webhooks/{id}

400
403
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/{id}/deliveries

Parameters

project_idstringpathrequired
idstringpathrequired
limitintegerquery
cursorstringquery

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/{id}/deliveries"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Page of Delivery, newest first
404
POSThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/{id}/test

Parameters

project_idstringpathrequired
idstringpathrequired

Code samples

cURL
curl -X POST "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/webhooks/{id}/test"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 The logged test delivery (status delivered or failed)
Example
{
  "attempts": 0,
  "created_at": "2024-01-01T00:00:00Z",
  "delivered_at": "2024-01-01T00:00:00Z",
  "endpoint_id": "string",
  "event_id": "string",
  "event_type": "string",
  "id": "string",
  "last_error": "string",
  "last_status": 0,
  "next_attempt_at": "2024-01-01T00:00:00Z",
  "status": "string"
}
Schema
attemptsintegerrequired
created_atstringrequired
delivered_atstring
endpoint_idstringrequired
event_idstringrequired
event_typestringrequired
idstringrequired
last_errorstring
last_statusinteger
next_attempt_atstringrequired
statusstringrequired
pending | delivered | failed
403
404
Updated