Webhook Relay

Activate relay endpoint

Registers the relay's inbound URL with the upstream platform so it starts sending events. Must be called once after creating an endpoint — without activation no events flow.

post/v1/webhooks/relay/{id}/activate

Request

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

Path parameters

idstring uuid required

Relay endpoint ID

Request body

webhookSecretstring nullable

Response

Activated 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.