Skip to main content
POST
Crea una destinazione dei webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required

https, con un nome pubblico: indirizzi privati, locali o con credenziali si rifiutano.

Required string length: 1 - 2048
events
enum<string>[]
required
Required array length: 1 - 50 elements

Un tipo di evento del catalogo.

Available options:
patient.created,
patient.updated,
patient.archived,
appointment.created,
appointment.rescheduled,
appointment.confirmed,
appointment.cancelled,
appointment.checked_in,
appointment.completed,
appointment.no_show,
treatment_plan.presented,
treatment_plan.accepted,
treatment_plan.rejected,
invoice.issued,
invoice.paid,
payment.received,
installment.overdue,
lead.created,
lead.converted,
task.created,
task.completed,
conversation.message_received,
conversation.handoff_requested,
call.logged
description
string
Maximum string length: 200

Response

La destinazione, con il segreto.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
url
string
required
description
string | null
required
events
enum<string>[]
required

Un tipo di evento del catalogo.

Available options:
patient.created,
patient.updated,
patient.archived,
appointment.created,
appointment.rescheduled,
appointment.confirmed,
appointment.cancelled,
appointment.checked_in,
appointment.completed,
appointment.no_show,
treatment_plan.presented,
treatment_plan.accepted,
treatment_plan.rejected,
invoice.issued,
invoice.paid,
payment.received,
installment.overdue,
lead.created,
lead.converted,
task.created,
task.completed,
conversation.message_received,
conversation.handoff_requested,
call.logged
enabled
boolean
required
disabledReason
enum<string> | null
required

too_many_failures: spenta dopo 50 consegne scartate di fila. Riaccendila con PATCH enabled=true.

Available options:
manual,
too_many_failures
consecutiveFailures
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
previousSecretExpiresAt
string | null
required

Fino a quest'istante si firma anche con il segreto precedente.

secretRotatedAt
string | null
required
createdAt
string
required
updatedAt
string
required
secret
string
required

whsec_...: si vede SOLO in questa risposta. Conservalo.