Destinations

Register a delivery destination

A destination is created once and named by id from every job, so a signing secret or a set of S3 keys is sent to us on one request and never appears in a job body again.

A webhook destination needs a public https URL. The response carries signing_secret once: we keep only an encrypted copy, so there is no endpoint that can show it to you again.

signing_secret is 64 hex characters: the hex encoding of a 32-byte key. Each delivery carries Ironfang-Signature: v1=<hex>, the HMAC-SHA256 of <Ironfang-Timestamp>.<raw body> keyed with those 32 bytes - decode the secret from hex before verifying, rather than using its text. The SDKs' verifyWebhook / verify_webhook take the secret as shown and decode it (from 3.0.1).

An s3 destination needs bucket, region, access_key and secret_key; endpoint (for a non-AWS provider), path_style and prefix are optional. Scope the credentials to the prefix you give us. They are never returned after creation.

Needs the render:destinations scope, which maps to the destinations.manage permission.

post/v1/destinations

Request

  • Base URL: https://api.ironfang.com/render
  • URL: https://api.ironfang.com/render/v1/destinations
  • Auth: HTTP bearer

Request body

access_keystring
bucketstring
endpointstring uri
namestring
path_styleboolean
prefixstring
regionstring
secret_keystring
session_tokenstring
type'webhook' | 's3' required
urlstring uri

webhook: a public https URL.

Response

The destination. A webhook also carries signing_secret, shown once: 64 hex characters encoding the 32-byte HMAC key. Decode hex before verifying signatures.

Changes

No recorded changes to this operation across all 1 revision of this API.