Authentication
API key or session token with thewebhooks:manage permission. API keys have it.
A webhook receives deliveries from both environments. Each delivery states its environment in the environment field, so you can route sandbox and production to the same endpoint or filter one out.
Request body
string
required
Absolute URL that receives
POST requests. It must start with https://: any other scheme returns 400 invalid_payload.string[]
required
At least one of:
event.created, event.status_changed, event.delivered, event.failed, event.no_response, sync.completed, device.synced, connectivity.degraded, connectivity.restored, team.created, team.updated, team.deleted, team.dispatched, team.status_requested, team.equipment.added, team.equipment.updated, team.equipment.removed, mission.created, mission.status_updated, sync.conflict_resolved, operation.reconciled, operation.unmatched, reconciliation.resolved, reconciliation.period_closed, data_incident.opened, data_incident.updated, continuity.degraded, continuity.restored, sla.violated, sla.uptime_below_target. See Webhook events for the data of each one.string
required
At least 16 characters. wede signs every delivery with this secret so you can verify it came from wede. Generate a long random value and keep it on your server. It is never returned by the API.
boolean
default:"true"
Set to
false to register the webhook without receiving deliveries.string
Up to 255 characters, for your own reference.
Example
Response
201 Created
string
Webhook ID (UUID).
string
Endpoint URL.
string[]
Subscribed events.
boolean
Whether deliveries are sent.
string | null
Your description.
string
Creation time.
integer
Consecutive failed delivery attempts. Starts at
0.POST /v1/webhooks/:webhook_id/test and check that your endpoint verifies the signature.