Sign in
Importer Webhooks

Update Importer Webhook

Update fields on an Importer Webhook. All body fields are optional; only provided fields are updated.

put/v1/importer-webhooks/{webhook_key}

Path parameters

webhook_keystring required

The org-unique key identifying the webhook.

Request body

urlstring

The URL that the importer will POST to.

type'batch' | 'metadata'

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

new_webhook_keystring

Optional new value for webhook_key. The path parameter identifies the existing webhook; this field renames it.

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. Cleared automatically if auth_type is changed to a non-basic value.

batch_sizeinteger nullable

Response

The request has succeeded.

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.