Docs
API Reference

Update Importer Webhook

put
https://api.oneschema.co/v1/importer-webhooks/

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The org-unique key identifying the webhook.

Body Params

All fields are optional. Only fields provided in the request body are updated; unspecified fields retain their existing values.

string

The URL that the importer will POST to.

string
enum

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

Allowed:
string

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

enum

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.

The shared secret used for basic auth. Cleared automatically if auth_type is changed to a non-basic value.

Responses

Updated 2 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago