Get Endpoint | Captain Docs

import requests
BASE_URL = "https://api.captain.dev"
API_KEY = "your_api_key"
ENDPOINT_ID = "whe_3f9a1c7e5b2d4a6c8e0f1a2b"
response = requests.get(
    f"{BASE_URL}/v2/webhooks/endpoints/{ENDPOINT_ID}",
    headers={"Authorization": f"Bearer {API_KEY}"},
    timeout=30.0,
)
response.raise_for_status()
data = response.json()
if data["disabled"]:
    print(f"Disabled: {data['disabled_reason'] or 'paused through the API'}")
else:
    print(f"Sending to {data['url']}")

{
  "endpoint_id": "whe_3f9a1c7e5b2d4a6c8e0f1a2b",
  "url": "https://example.com/webhooks/captain",
  "description": "Indexing notifications",
  "event_types": [
    "job.completed",
    "job.completed_with_errors",
    "job.failed"
  ],
  "collection_ids": [],
  "sync_ids": [],
  "sources": [],
  "channels": [],
  "include_collection_name": true,
  "disabled": false,
  "disabled_reason": null,
  "last_delivery": {
    "at": "2026-09-23T10:05:13Z",
    "status": "succeeded"
  },
  "created_at": "2026-09-20T16:42:08Z",
  "updated_at": "2026-09-20T16:42:08Z"
}

Get one webhook endpoint: its URL, filters, whether it is disabled and why, and the most recent delivery. The secret is never included.

disabled_reason is delivery_failures when Captain disabled the endpoint after sustained failed deliveries. Re-enable it with PATCH and {"disabled": false}, then recover the events it missed.

Get one webhook endpoint: its URL, filters, whether it is disabled and why, and the most recent delivery. The secret is never included. `disabled_reason` is `delivery_failures` when Captain disabled the endpoint after sustained failed deliveries. Re-enable it with `PATCH` and `{"disabled": false}`, then recover the events it missed.

Path parameters

endpoint_idstringRequired

The endpoint’s id (whe_...).

Response

Successful Response

endpoint_idstring

The endpoint’s id (whe_...).

urlstring

HTTPS URL that receives events.

descriptionstring

Free-text label. Empty string when not set.

event_typeslist of strings

Events this endpoint receives. Empty means all five.

collection_idslist of strings

Collection filter. Empty means every collection.

sync_idslist of strings

Sync filter. Empty means no sync filter.

sourceslist of strings

Source filter (api, sync). Empty means both.

channelslist of strings

Filters set in Captain Studio’s Webhooks page that cannot be expressed as collection_ids, sync_ids and sources. Empty for endpoints whose filters were set through the API. Setting collection_ids, sync_ids or sources with PATCH replaces them.

include_collection_nameboolean

Whether payloads sent to this endpoint may carry collection_name.

disabledboolean

true when no events are being sent to this endpoint.

disabled_reasonstring or null

delivery_failures when Captain disabled the endpoint after sustained failed deliveries. null when it is enabled or was paused through the API.

last_deliveryobject or null

The most recent delivery, or null before the first one.

created_atstringformat: "date-time"

updated_atstringformat: "date-time"

Errors

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error