Delivery

Create a destination

Webhooks: every successful run of the selected sources is POSTed to the URL, signed (Standard Webhooks) and retried with backoff for 24 hours. The signing secret is returned once.

post/v1/destinations

Request

  • Base URL: https://sourcefinch.com
  • URL: https://sourcefinch.com/v1/destinations
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes retries safe for 24 hours. Reusing a key with a different request returns 422.

X-Request-Idstring

Echoed in the response and logs; generated when absent.

SourceFinch-Projectstring uuid

Project UUID. Required for session tokens; API keys are bound to their project.

Request body

kind'webhook' required

Webhooks are available now; credential-backed destinations follow (ADR 0011)

namestring required
urlstring uri required
mode'changes' | 'snapshot'
source_idsstring[] nullable

Response

The destination, with its signing secret (once)

idId required(unresolved $ref)
project_idProjectId required(unresolved $ref)
kind'webhook' | 'email' | 'slack' | 'google_sheets' | 'postgres' | 's3' | 'warehouse' required
nameName required(unresolved $ref)
configConfig required(unresolved $ref)
modeMode required(unresolved $ref)
source_idsSourceIds required(unresolved $ref)
statusStatus required(unresolved $ref)
status_reasonStatusReason required(unresolved $ref)
created_atCreatedAt required(unresolved $ref)
updated_atUpdatedAt required(unresolved $ref)
signing_secretstring nullable required

Webhooks only, shown once: verify the webhook-signature header with it (Standard Webhooks, HMAC-SHA256)

Changes

No recorded changes to this operation across all 2 revisions of this API.