Webhooks

Get Webhook

Retrieve details of a single webhook including its status, event types, and delivery information.

get/webhooks/{webhookId}

Request

Base URL: https://app.lettr.com/api
URL: https://app.lettr.com/api/webhooks/{webhookId}
Auth: HTTP bearer

Path parameters

webhookIdstring required

Example:webhook-abc123

The webhook ID to retrieve

Response

Webhook retrieved successfully

messagestring required

Human-readable response message

Example response

{
  "message": "Webhook retrieved successfully.",
  "data": {
    "id": "webhook-abc123",
    "name": "Order Notifications",
    "url": "https://example.com/webhook",
    "enabled": true,
    "event_types": [
      "message.delivery",
      "message.bounce"
    ],
    "auth_type": "basic",
    "has_auth_credentials": true,
    "last_successful_at": "2024-01-15T10:30:00+00:00",
    "last_status": "success"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.