Webhook Subscriptions

Create or reconcile a webhook listener

Registers a listener under a stable name you choose. Calling it again with the same name reconciles the existing listener instead of creating a second one, so it is safe to run on every application boot. A signing secret is required, because deliveries are only signed when the subscription has one.

put/v1/webhooks/subscriptions/by-key/{key}

Request

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

Path parameters

keystring required

Stable listener name, unique per account

Request body

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

Response

Created or reconciled 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.