Skip to main content

CreateWebhookEndpointDto

urlstringrequired
Example: https://hooks.example.com/minetech
descriptionstring

Possible values: <= 500 characters

environmentstringrequired

Possible values: [live, test]

enabledEventsstring[]

Events to subscribe to. An EMPTY array means every event. Fetch the current list from GET /developer/webhooks/event-types — never hardcode it.

Possible values: [safety.incident.reported, safety.incident.resolved, safety.inspection.completed, operations.production_log.created, operations.shift_log.submitted, operations.lot.custody_transferred, compliance.permit.expiring, compliance.submission.status_changed, workforce.payroll_batch.completed, inventory.stock.threshold_breached, environment.threshold.breached, webhook.test]

customHeaders object

Extra headers sent with every delivery, e.g. your own auth token.

property name*string
CreateWebhookEndpointDto
{
  "url": "https://hooks.example.com/minetech",
  "description": "string",
  "environment": "live",
  "enabledEvents": [
    "safety.incident.reported"
  ],
  "customHeaders": {}
}