Webhook Relay

Create relay endpoint

Registers a new webhook relay endpoint against a connection. Choose which event types trigger deliveries and what actions should run when they fire (forward to a URL, run a passthrough call, etc.). The endpoint needs to be activated next before the upstream platform starts sending events.

post/v1/webhooks/relay

Request

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

Request body

connectionKeystring required
createWebhookboolean nullable
descriptionstring nullable
eventFiltersstring[] nullable
metadataunknown
tagsstring[] nullable

Response

Created relay endpoint

activeboolean required
changeLogChangeLog required
connectionIdstring uuid required
createdAtstring date-time required
deletedboolean required
descriptionstring nullable
eventFiltersstring[] required
idstring uuid required
metadataunknown
tagsstring[] required
updatedAtstring date-time required
urlstring nullable
userIdstring uuid required
versionstring required
warningstring nullable
webhookPayloadunknown

Changes

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