Skip to content
GETAPI key

List endpoints

GETapi.schedulesmcp.com/v1/webhooks

Every webhook endpoint on your account, newest first, with its health. failure_count counts consecutive failures and resets to zero on a success. last_delivery_at moves only on a success, so a null there on a busy endpoint is what a failing signature check looks like from our side. The signing secret is never returned. Read, so a valid key is enough.

Response schema

11 fields

Derived from the example response, nested as the JSON is.

okboolean

Whether the request succeeded.

dataobject

The payload. Everything an endpoint returns sits under this key.

itemsobject[]

The list of results.

items[]object
idstring

Stable identifier for the record. On the tracking endpoints this is the container UUID, except on a portfolio summary row, where it is the container number.

urlstring

Where we POST the events.

event_typesstring[]

The events this endpoint receives. Anything not listed is not delivered.

descriptionstring

The carrier own phrasing for the event, falling back to our word for the code.

activeboolean

False while the endpoint is paused. A paused endpoint keeps its secret and its history.

failure_countnumber

Consecutive failed deliveries. It resets on the first success, and a sustained climb is what disables an endpoint.

last_delivery_atstring

When we last attempted a delivery. Null before the first one.

created_atstring

When the record was created (ISO 8601).

curl 'https://api.schedulesmcp.com/v1/webhooks' \
  -H "Authorization: Bearer smcp_YOUR_API_KEY"
Response
{
  "ok": true,
  "data": {
    "items": [
      { "id": "3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10",
        "url": "https://hooks.example.com/schedulesmcp",
        "event_types": ["blank_sailing", "cutoff_approaching"],
        "description": "Sailing alerts, booking desk",
        "active": true,
        "failure_count": 0,
        "last_delivery_at": "2026-08-11T09:14:31.204Z",
        "created_at": "2026-08-11T09:12:04.881Z" }
    ]
  }
}