v1

latestOpenAPI 3.1.0proprietary2026-07-24156175241.3 KB
Event Webhooks

Get an event webhook

Retrieves a single event webhook by key.

get/v1/event-webhooks/{webhook_key}

Path parameters

webhook_keystring required

The key of the event webhook.

Query parameters

product_area'importer' | 'multi_file_feeds'

Product area that owns the event webhook.

Response

The request has succeeded.

idinteger

The unique identifier of the event webhook.

webhook_keystring

The org-unique key identifying this event webhook.

product_area'importer' | 'multi_file_feeds'

Product area that owns the event webhook.

urlstring

The HTTPS URL that OneSchema will POST event payloads to.

descriptionstring

Optional human-readable description.

eventsEventWebhookEventType[]

Event types subscribed to by this webhook.