Developers
API referenceWebhook endpoints

Retrieve a webhook endpoint

GET
/webhook-endpoints/{id}

One endpoint, without its secret.

Scope: webhooks:manage.

Authorization

bearerAuth
AuthorizationBearer <token>

A Platform API token, wyc_live_... or wyc_test_..., created at Settings > API tokens in the dashboard.

In: header

Path Parameters

id*string

Id of the webhook endpoint.

Match^whe_[A-Za-z0-9]{24}$

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/webhook-endpoints/string"
{  "id": "whe_2xL7rCkZa8bW1vT9yN6pDmQ3",  "object": "webhook_endpoint",  "livemode": true,  "url": "https://example.com/webhooks/woodyoucare",  "description": "CRM sync",  "events": [    "allocation.created",    "allocation.planted",    "verification.published"  ],  "include_personal_data": false,  "status": "enabled",  "disabled_reason": null,  "created_at": "2026-09-28T09:00:00Z",  "updated_at": "2026-09-28T09:00:00Z"}

Create a webhook endpoint POST

Creates an endpoint and returns its signing `secret` once. Store it; it is needed to verify the `WoodYouCare-Signature` header. Endpoints created with a test token only receive test events. Scope: `webhooks:manage`.

Update a webhook endpoint PATCH

Changes the URL, events, description or status. Setting `status` to `enabled` re-enables an endpoint the Platform disabled after failed deliveries. Scope: `webhooks:manage`.