Webhook Subscriptions

Create organization webhook subscription

Subscribes a URL to receive webhooks when events happen in an organization. Choose which event types you care about and optionally provide a signing secret so you can verify the payloads.

post/v1/webhooks/subscriptions/organizations/{org_id}

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/webhooks/subscriptions/organizations/{org_id}
  • Auth: API key in header X-One-Secret

Path parameters

org_idstring uuid required

Organization ID

Request body

activeboolean nullable
descriptionstring nullable
eventsWebhookEventType[] required
metadataunknown
secretstring nullable
urlstring required

Response

Created org webhook subscription

activeboolean required
changeLogChangeLog required
createdAtstring date-time required
deletedboolean required
descriptionstring nullable
eventsstring[] required
idstring uuid required
keystring required
metadataunknown
organizationIdstring uuid nullable
projectIdstring uuid nullable
tagsstring[] required
updatedAtstring date-time required
urlstring required
userIdstring uuid required
versionstring required

Changes

No recorded changes to this operation across all 1 revision of this API.