API reference · Webhooks
POST/api/v1/webhooks/templates

Create webhook template

Creates a reusable webhook template. Requires system_settings RBAC.

RBAC · webhook

Request body

Content type: application/json · schema WebhookTemplateBodyV1

namestringRequired
descriptionstring
categorystringRequired
default_configobjectRequired
required_fieldsarray of string
itemsstring
supported_eventsarray of WebhookEventTypeV1
itemsstring
Enum: ticket.createdticket.updatedticket.status_changedticket.assignedticket.closedticket.comment.addedproject.createdproject.updatedproject.completedproject.task.createdproject.task.updatedproject.task.completedclient.createdclient.updatedcontact.createdcontact.updatedtime.entry.createdtime.entry.updatedtime.entry.approvedinvoice.createdinvoice.finalizedinvoice.sentinvoice.paidasset.createdasset.updatedasset.maintenance.scheduledasset.maintenance.completedsystem.backup.completedsystem.backup.failedsystem.maintenance.startedsystem.maintenance.completedworkflow.execution.startedworkflow.execution.completedworkflow.execution.failedcustom.event
is_system_templateboolean

Response body

Success response 201 · schema WebhookTemplateEnvelopeV1

dataobjectRequired
template_idstring <uuid>Required
namestringRequired
descriptionstring
categorystringRequired
default_configobjectRequired
url_templatestring
methodstringRequired
Enum: GETPOSTPUTPATCHDELETE
headersobject
payload_templatestringRequired
security_typestring
Enum: nonebasic_authbearer_tokenapi_keyhmac_signatureoauth2
required_fieldsarray of string
itemsstring
supported_eventsarray of WebhookEventTypeV1
itemsstring
Enum: ticket.createdticket.updatedticket.status_changedticket.assignedticket.closedticket.comment.addedproject.createdproject.updatedproject.completedproject.task.createdproject.task.updatedproject.task.completedclient.createdclient.updatedcontact.createdcontact.updatedtime.entry.createdtime.entry.updatedtime.entry.approvedinvoice.createdinvoice.finalizedinvoice.sentinvoice.paidasset.createdasset.updatedasset.maintenance.scheduledasset.maintenance.completedsystem.backup.completedsystem.backup.failedsystem.maintenance.startedsystem.maintenance.completedworkflow.execution.startedworkflow.execution.completedworkflow.execution.failedcustom.event
is_system_templateboolean
created_atstring <date-time>Required
updated_atstring <date-time>Required
tenantstring <uuid>Nullable
metaobject

Response codes

201
Template created.
400
Invalid request payload, query, or webhook id format.
401
API key missing/invalid or key user missing.
403
Webhook RBAC permission denied.
500
Unexpected webhook operation failure.