Docs
API Reference

Update an event webhook

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

Updates selected fields on an existing event webhook.

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

The key of the event webhook.

Query Params
string
enum

Product area that owns the event webhook.

Allowed:
Body Params

Updates selected fields on an Importer event webhook. Only fields provided in the request body are updated; unspecified fields retain their existing values.

string
enum

Product area that owns the event webhook.

Allowed:
string

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

string

The HTTPS URL that OneSchema will POST event payloads to.

string | null

Optional human-readable description. Passing null stores an empty string.

string | null

Optional shared secret sent using HTTP Basic authentication. Passing null clears the secret.

events
array of objects

Importer event types to subscribe to.

events
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