Subscribe Event Webhook

import requests
BASE_URL = "https://api.runcaptain.com"
API_KEY = "your_api_key"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}
response = requests.post(
    f"{BASE_URL}/v2/syncs/{sync_id}/webhooks",
    headers=headers
)
print(response.json())

{
  "sync_id": "sync_7e0abee6e110457db2c8",
  "subscribe_url": "https://runcaptain.com/api/s3-events/80PQJVil1beanR5bRB_BpZo1O1Yu6SRjAhKRBITD_Ao",
  "secret_set": true,
  "instructions": [
    "Create an SNS topic in the bucket's account/region.",
    "Add an S3 event notification for s3:ObjectCreated:* and s3:ObjectRemoved:* -> that SNS topic.",
    "Subscribe the topic to the subscribe_url above (HTTPS). Captain auto-confirms the subscription."
  ]
}

Enable near-real-time, event-driven updates for a sync. Mints a webhook secret and returns the subscribe URL plus setup steps for wiring S3 ObjectCreated/ObjectRemoved events through an SNS topic to Captain. Events complement the scheduled reconcile (which remains the reliability backstop).

Path parameters

sync_idstringRequired

The sync id.

Response

Successful Response

sync_idstringOptional

subscribe_urlstringOptional

Webhook target to subscribe your SNS topic to.

secret_setbooleanOptional

instructionslist of stringsOptional

Setup steps for wiring S3 events -> SNS -> the subscribe URL.

Path parameters

Headers

Response