Sign in
Importer Webhooks

Create Importer Webhook

Create a new Importer Webhook for the organization.

post/v1/importer-webhooks

Request body

urlstring required

The URL that the importer will POST to.

webhook_keystring required

A unique (per-org) key identifying this webhook.

type'batch' | 'metadata' required

The delivery mode for the webhook. batch delivers rows in batches; metadata delivers only the import metadata.

auth_type'basic' | 'bearer_user_jwt' nullable

The authentication mode for requests to the webhook URL. basic requires a secret_key. bearer_user_jwt attaches the end-user JWT as a bearer token. Omit (null) for unauthenticated delivery.

secret_keystring nullable

Required when auth_type is basic. Ignored for other auth types.

batch_sizeinteger nullable

Optional batch size (number of rows per webhook request) for batch-type webhooks.

Response

The request has succeeded and a new resource has been created as a result.

idinteger

The unique identifier of the importer webhook.

webhook_keystring

The org-unique key identifying this webhook.

type'batch' | 'metadata'

The delivery mode for the webhook. batch delivers rows in batches; metadata delivers only the import metadata.

urlstring

The URL that the importer will POST to.

auth_type'basic' | 'bearer_user_jwt' nullable

The authentication mode for requests to the webhook URL. basic requires a secret_key. bearer_user_jwt attaches the end-user JWT as a bearer token. Omit (null) for unauthenticated delivery.

secret_keystring nullable

The shared secret used for basic auth. Only returned to admin and developer API key users.

batch_sizeinteger nullable

Optional batch size (number of rows per webhook request) for batch-type webhooks.

Changes

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