Sources

Create a source

POST/v1/sources

Creates a source and returns its ingest URL. How the sender's requests are verified is set with auth_type.

Parameters

Body parameters13
namestringRequired

2–41 lowercase letters, numbers or dashes, starting with a letter or number. Must be unique.

description?string

Up to 200 characters.

type?string

How the source is labelled in the dashboard.

auth_type?string

How requests are verified: none, hmac, bearer, apikey, basic, standard (Standard Webhooks) or hmac_ts. Defaults to none.

secret?string

The signing secret or token. Required for every auth_type except none and basic.

header?string

For hmac and apikey: the header that carries the signature or key.

encoding?string

For hmac: hex (default) or base64.

prefix?string

For hmac: text before the signature in the header, such as sha256=.

username?string

For basic.

password?string

For basic.

tolerance?integer

For standard: seconds a timestamp may be off, 0 to 3600. Default 300.

dedupe?string

A body path whose value identifies a duplicate delivery.

correlate?string

A body or header path whose value agents subscribe on. See Subscriptions.

Returns

201The sample response is on the right.Errors return error and message; see Errors and limits.