Update Endpoint | Captain Docs

import requests
BASE_URL = "https://api.captain.dev"
API_KEY = "your_api_key"
ENDPOINT_ID = "whe_3f9a1c7e5b2d4a6c8e0f1a2b"
response = requests.patch(
    f"{BASE_URL}/v2/webhooks/endpoints/{ENDPOINT_ID}",
    headers={"Authorization": f"Bearer {API_KEY}"},
    json={
        "collection_ids": [
            "2b8e6f10-3c4d-4e5f-8a9b-0c1d2e3f4a5b"
        ],
        "sources": [
            "sync"
        ]
    },
    timeout=30.0,
)
response.raise_for_status()
data = response.json()
print(f"Collections: {data['collection_ids']}, sources: {data['sources']}")

{
  "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": [
    "2b8e6f10-3c4d-4e5f-8a9b-0c1d2e3f4a5b"
  ],
  "sync_ids": [],
  "sources": [
    "sync"
  ],
  "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-23T11:20:44Z"
}

Change an endpoint’s URL, filters, description or include_collection_name, or pause and resume it with disabled. Only the fields sent change. Send an empty list to remove a filter.

Setting disabled to false also re-enables an endpoint that Captain disabled after sustained delivery failures. Events for jobs that finished while the endpoint was disabled are not sent automatically; use the recover endpoint for those.

Change an endpoint's URL, filters, description or `include_collection_name`, or pause and resume it with `disabled`. Only the fields sent change. Send an empty list to remove a filter. Setting `disabled` to `false` also re-enables an endpoint that Captain disabled after sustained delivery failures. Events for jobs that finished while the endpoint was disabled are not sent automatically; use the recover endpoint for those.

Path parameters

endpoint_idstringRequired

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

Request

This endpoint expects an object.

collection_idslist of strings or nullOptional

Only jobs that index into these collections, by collection id (up to 10). Empty or omitted means every collection.

descriptionstring or nullOptional

Free-text label, up to 200 characters.

disabledboolean or nullOptional

true pauses deliveries, false resumes them. Setting false also re-enables an endpoint that was disabled after sustained delivery failures.

event_typeslist of strings or nullOptional

Events to receive: any of job.completed, job.completed_with_errors, job.failed, job.timed_out, job.cancelled. Empty or omitted means all five.

include_collection_nameboolean or nullOptional

Send collection_name in payloads. When any endpoint receiving an event turns this off, that event carries collection_name: null.

sourceslist of strings or nullOptional

Only jobs from these sources: api (started by a call to an index endpoint) or sync (started by a storage sync). Empty or omitted means both.

sync_idslist of strings or nullOptional

Only jobs started by these syncs (up to 10). Requires sources to include sync or be empty.

urlstring or nullOptional

HTTPS URL that receives events. Must start with https://, be reachable from the public internet, and be at most 2,048 characters.

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

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

503

Service Unavailable Error