API Reference
Webhooks API
Register and manage webhook endpoints for pin lifecycle events.
Overview
Webhook APIs let you manage subscriptions while webhook delivery services push pin lifecycle events to your endpoint.
What You Will Learn
- Create/list/get/update/delete webhook subscriptions.
- Event subscriptions, secrets, and enable/disable state.
- How webhook API management differs from webhook delivery behavior.
Implementation Checklist
- Create at least one HTTPS webhook endpoint and store the shared secret safely.
- Use PATCH for event list or secret rotation.
- Use GET by ID for audit/debug and DELETE when decommissioning endpoints.
Relevant Endpoints
POST
/v1/webhooksCreate a webhook subscription.
GET
/v1/webhooksList webhook subscriptions.
GET
/v1/webhooks/{webhook_id}Fetch one webhook.
PATCH
/v1/webhooks/{webhook_id}Update webhook fields.
DELETE
/v1/webhooks/{webhook_id}Delete a webhook.