Skip to content

Create webhook

POST
/api/webhook-subscriptions/

Authorizations

Request Body

object
id

Webhook identifier

integer
created_by
object
value

User identifier

integer
text

User name

string
color
string format: hex
username
string format: email
foto_url_absolute_path
string format: uri
created
string format: date-time
updated
string format: date-time
url
required
string format: uri
event
required
string
Allowed values: CITA_CREATED CITA_UPDATED VENTA_CREATED VENTA_UPDATED CLIENTE_CREATED CLIENTE_UPDATED PRODUCTO_CREATED PRODUCTO_UPDATED SERVICIO_CREATED SERVICIO_UPDATED
is_active
boolean
is_application_managed
boolean
managing_application
string

Responses

201

The created webhook

object
id

Webhook identifier

integer
created_by
object
value

User identifier

integer
text

User name

string
color
string format: hex
username
string format: email
foto_url_absolute_path
string format: uri
created
string format: date-time
updated
string format: date-time
url
required
string format: uri
event
required
string
Allowed values: CITA_CREATED CITA_UPDATED VENTA_CREATED VENTA_UPDATED CLIENTE_CREATED CLIENTE_UPDATED PRODUCTO_CREATED PRODUCTO_UPDATED SERVICIO_CREATED SERVICIO_UPDATED
is_active
boolean
is_application_managed
boolean
managing_application
string

400

The request is malformed, required fields are missing.

401

Access key was not provided in the X-Koibox-Key header

Headers

WWW-Authenticate
string
default: X-Koibox-Key

Indicates the required header for authentication

403

A valid access key was not provided