Skip to main content
GET
/
webhooks
/
{id}
Get a webhook subscription
curl --request GET \
  --url https://api.demo.cula.earth/tracking/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Cula-Organisation-Id: <cula-organisation-id>'
{
  "id": "wbh_01kqzcjrpyf27tged31m134keg",
  "url": "https://hooks.example.com/cula",
  "events": [
    "delivery.created",
    "material_sourcing.created"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

OAuth2 client credentials flow. Exchange your client_id and client_secret for a short-lived access token, then pass it as a Bearer token in the Authorization header.

Headers

​
Cula-Organisation-Id
string
required

Organisation ID that scopes this request. The authenticated consumer must be authorized for this organisation. Omitting this header returns 400; passing an unauthorised org returns 403.

Path Parameters

​
id
string
required

Webhook ID (TypeID format).

Response

Webhook subscription detail.

​
id
string
required
Example:

"wbh_01kqzcjrpyf27tged31m134keg"

​
url
string<uri>
required
Example:

"https://hooks.example.com/cula"

​
events
string[]
required

Event types this webhook subscribes to.

Example:
[
  "delivery.created",
  "material_sourcing.created"
]
​
status
enum<string>
required
Available options:
enabled,
disabled
​
created_at
string<date-time>
required
​
description
string | null
​
updated_at
string<date-time>