Skip to main content
POST
Pause an endpoint

Authorizations

Authorization
string
header
required

A workspace API key with the outbound_webhooks:write scope, sent as Authorization: Bearer <key>.

Path Parameters

endpoint_id
string
required

The endpoint's ID.

Example:

"6ac2a82edfafd1b6c6a9c27d"

Response

Successful Response

description
string
required

A note for your own reference, up to 200 characters.

health
enum<string>
required

How recent deliveries went. unknown before the first delivery, healthy after a success, failing after 3 failed deliveries in a row. degraded is reserved.

Available options:
unknown,
healthy,
degraded,
failing
id
string
required

The endpoint's ID.

selected_event_types
string[]
required

The event types sent to this endpoint.

state
enum<string>
required

pending until it passes the activation test, then active. paused when you paused it, auto_paused when Base44 paused it after 10 failed deliveries in a row over at least 5 days. Only active endpoints receive events.

Available options:
pending,
active,
paused,
auto_paused
target_url
string
required

The URL that receives events.

activated_at
string<date-time> | null

When the endpoint first became active at its current URL, in UTC. Events from before this time aren't sent to it.

consecutive_failed_deliveries
integer
default:0

Deliveries in a row that ran out of attempts. A success resets it to 0.

created_date
string<date-time> | null

When the endpoint was registered, in UTC.

last_failure_at
string<date-time> | null

When a delivery last ran out of attempts. In UTC. Absent until it first happens.

last_success_at
string<date-time> | null

When a delivery last succeeded. In UTC. Absent until it first happens.