API Reference

Authorization: Bearer {api_key}

{
  "data": { ... }
}

{
  "data": [ ... ],
  "total": 100,
  "limit": 50,
  "offset": 0,
  "hasMore": true
}

{
  "error": {
    "message": "Error description",
    "code": "error_code"
  }
}

GET /applications

GET /applications/{id}

GET /applications/uid/{uid}

POST /applications

{
  "name": "Acme Corp",
  "uid": "customer_123",
  "metadata": { "plan": "enterprise" }
}

PATCH /applications/{id}

{
  "name": "New Name",
  "metadata": { "plan": "business" }
}

DELETE /applications/{id}

GET /applications/{appId}/endpoints

GET /applications/{appId}/endpoints/{id}

POST /applications/{appId}/endpoints

{
  "url": "https://example.com/webhooks",
  "description": "Production endpoint",
  "headers": { "X-Custom": "value" },
  "filterTypes": ["order.*"],
  "rateLimit": 100,
  "rateLimitPeriod": 60
}

{
  "data": {
    "id": "ep_123",
    "url": "https://example.com/webhooks",
    "secret": "whsec_..."
  }
}

PATCH /applications/{appId}/endpoints/{id}

DELETE /applications/{appId}/endpoints/{id}

POST /applications/{appId}/endpoints/{id}/rotate-secret

GET /applications/{appId}/endpoints/{id}/stats

POST /applications/{appId}/endpoints/{id}/recover

GET /event-types

GET /event-types/{id}

GET /event-types/name/{name}

POST /event-types

{
  "name": "order.created",
  "displayName": "Order Created",
  "description": "Triggered when an order is placed",
  "category": "Orders",
  "schema": { "type": "object" }
}

PATCH /event-types/{id}

DELETE /event-types/{id}

GET /applications/{appId}/subscriptions

GET /applications/{appId}/subscriptions/{id}

POST /applications/{appId}/subscriptions

{
  "endpointId": "ep_123",
  "eventTypeId": "evt_456"
}

PATCH /applications/{appId}/subscriptions/{id}

{
  "isEnabled": false
}

DELETE /applications/{appId}/subscriptions/{id}

POST /applications/{appId}/messages

{
  "eventType": "order.created",
  "payload": {
    "orderId": "ord_123",
    "amount": 99.99
  },
  "eventId": "unique_event_id",
  "metadata": { "source": "api" },
  "endpointIds": ["ep_123"]
}

{
  "data": {
    "messageId": "msg_123",
    "outboundMessages": [
      { "id": "out_1", "endpointId": "ep_123", "status": "pending" }
    ]
  }
}

GET /applications/{appId}/messages

GET /applications/{appId}/messages/{id}

POST /applications/{appId}/messages/{id}/resend

GET /applications/{appId}/outbound-messages

GET /applications/{appId}/outbound-messages/{id}

GET /applications/{appId}/outbound-messages/{id}/attempts

POST /applications/{appId}/outbound-messages/{id}/retry

POST /applications/{appId}/portal-tokens

{
  "expiresIn": 3600
}

{
  "data": {
    "id": "ptk_123",
    "token": "whpt_...",
    "expiresAt": "2024-01-15T11:30:00Z"
  }
}

DELETE /applications/{appId}/portal-tokens/{id}

GET /portal/application

GET /portal/endpoints
POST /portal/endpoints
PATCH /portal/endpoints/{id}
DELETE /portal/endpoints/{id}
POST /portal/endpoints/{id}/rotate-secret

GET /portal/event-types

GET /portal/subscriptions
POST /portal/subscriptions
DELETE /portal/subscriptions/{id}

GET /portal/messages
GET /portal/messages/{id}

signature = HMAC-SHA256(
  key: base64_decode(secret),
  message: "{webhook-id}.{webhook-timestamp}.{body}"
)