ShortyShorty
API Reference

Create a webhook endpoint

Registers an HTTPS endpoint for job events and returns it with its `whsec_` signing secret, which is shown only in this response.

POST
/v1/webhook-endpoints

Registers an HTTPS endpoint for job events and returns it with its whsec_ signing secret, which is shown only in this response. Shorty immediately POSTs a signed ping event to the URL; a 2xx answer sets verified_at, and only verified endpoints receive events. A URL that is not public HTTPS on port 443 is refused with 400 validation_failed; an account already at its endpoint limit gets 429 quota_exhausted.

Authorization

BearerApiKey
AuthorizationBearer <token>

A Shorty API key, sent as Authorization: Bearer <key>. An OAuth 2.1 access token issued to a connected app is also accepted on the same header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/webhook-endpoints" \  -H "Content-Type: application/json" \  -d '{    "url": "string",    "event_types": [      "job.succeeded"    ]  }'
{  "endpoint": {    "id": "string",    "url": "string",    "description": "string",    "event_types": [      "string"    ],    "enabled": true,    "verified_at": "string",    "disabled_at": "string",    "disabled_reason": "string",    "created_at": "string"  },  "secret": "string"}

List webhook endpoints GET

Returns the authenticated account’s webhook endpoints, newest first. Signing secrets are never listed: an endpoint’s secret is returned once, when it is created.

Delete a webhook endpoint DELETE

Deletes one of the authenticated account’s webhook endpoints and any deliveries still queued for it. A non-existent or foreign id returns 404.