Linkable
Webhooks

Register a webhook

POST
/v1/me/webhooks

Register a new webhook endpoint. The response includes the plaintext signing secret once — store it now; it is never returned again. A client may register at most 5 webhooks.

Authorization

ClientToken
AuthorizationBearer <token>

Bearer token issued by Linkable. Pass in the Authorization: Bearer <token> header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/me/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com",    "topics": [      "order.created"    ]  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "url": "http://example.com",  "description": "string",  "topics": [    "order.created"  ],  "is_active": true,  "consecutive_failures": 0,  "disabled_reason": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "secret": "string"}