Docs
API Reference

Create an event webhook

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

Creates an event webhook for a supported product area.

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

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

string
enum
required

Product area that owns the event webhook.

Allowed:
string
required

The HTTPS URL that OneSchema will POST event payloads to.

string | null

Optional human-readable description. Defaults to an empty string.

events
array of objects

Importer event types to subscribe to. Defaults to an empty array.

events
string | null

Optional shared secret sent using HTTP Basic authentication.

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