Skip to content
synpute

Events

Create a webhook endpoint

Preview

Register an HTTPS endpoint for events. The signing secret is returned once; verify each delivery's Synpute-Signature header with it.

post/v1/webhook-endpoints

Body parameters

eventsarray of stringrequired
Event types to send
urlstringrequired
HTTPS URL

Response 201 · WebhookEndpoint

createdstringrequired
When the record was created
eventsarray of stringrequired
Event types sent here
idstringrequired
Endpoint ID
objectstringrequired
Object type
secretstringrequired
Signing secret, shown once at creation
statusstringrequired
State
enableddisabled
urlstringrequired
HTTPS URL

Errors

400return the standard error shape.