Webhooks | Aivyro Knowledge

Aivyro tells your HTTPS endpoint when CRM or inbox state changes. No polling.

Official Aivyro contentAligned with the current public contract

POST/api/v1/webhooks

Subscribe an HTTPS endpoint. The URL must be HTTPS and must not point at a private network.

HTTP	Path	Scope
GET	`/api/v1/webhooks`	`rest.crm.webhooks.read`
POST	`/api/v1/webhooks`	`rest.crm.webhooks.write`
GET	`/api/v1/webhooks/{id}`	`rest.crm.webhooks.read`
PATCH	`/api/v1/webhooks/{id}`	`rest.crm.webhooks.write`
DELETE	`/api/v1/webhooks/{id}`	`rest.crm.webhooks.write`
GET	`/api/v1/webhooks/{id}/deliveries`	`rest.crm.webhooks.read`
POST	`/api/v1/webhooks/{id}/rotate_secret`	`rest.crm.webhooks.write`

GET /api/v1/webhooks returns a JSON array, not a cursor page. Empty workspace: []. signing_secret appears only on create and rotate.

Fields

Field	Type	Notes
id	UUID	Immutable.
url	string	HTTPS. No private network.
events	string[]	At least one on create.
active	boolean	PATCH to pause.
signing_secret	string	Create and rotate only.

EventsCRM and inbox. Wildcards and what fires conversation.updated.Verify signatureHMAC-SHA256 of the raw body. Secret shown once.

POST /api/v1/webhooks

curl -sS -X POST "$AIVYRO_API_BASE/api/v1/webhooks" \
  -H "Authorization: Bearer $AIVYRO_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com/aivyro/hooks","events":["contact.created","deal.updated"]}'