OpenAPI Reference
Webhooks
Webhook registration and delivery management.
curl -X GET "https://example.com/api/v1/webhooks"[ { "id": "string", "spaceId": "string", "baseId": "string", "name": "string", "eventType": "record.created", "enabled": true, "createdBy": "string", "createdAt": "string", "updatedAt": "string", "lastTriggeredAt": "string", "lastStatus": "success", "actionKind": "webhook", "config": { "targetUrl": "http://example.com", "hasSecret": true, "headers": { "property1": "string", "property2": "string" } } }]Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/webhooks" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "eventType": "record.created", "actionKind": "webhook", "config": { "targetUrl": "http://example.com" } }'{ "id": "string", "spaceId": "string", "baseId": "string", "name": "string", "eventType": "record.created", "enabled": true, "createdBy": "string", "createdAt": "string", "updatedAt": "string", "lastTriggeredAt": "string", "lastStatus": "success", "actionKind": "webhook", "config": { "targetUrl": "http://example.com", "hasSecret": true, "headers": { "property1": "string", "property2": "string" } }}curl -X GET "https://example.com/api/v1/webhooks/string"{ "id": "string", "spaceId": "string", "baseId": "string", "name": "string", "eventType": "record.created", "enabled": true, "createdBy": "string", "createdAt": "string", "updatedAt": "string", "lastTriggeredAt": "string", "lastStatus": "success", "actionKind": "webhook", "config": { "targetUrl": "http://example.com", "hasSecret": true, "headers": { "property1": "string", "property2": "string" } }}curl -X DELETE "https://example.com/api/v1/webhooks/string"{ "success": true}Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "https://example.com/api/v1/webhooks/string" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "eventType": "record.created", "actionKind": "webhook", "config": { "targetUrl": "http://example.com" } }'{ "id": "string", "spaceId": "string", "baseId": "string", "name": "string", "eventType": "record.created", "enabled": true, "createdBy": "string", "createdAt": "string", "updatedAt": "string", "lastTriggeredAt": "string", "lastStatus": "success", "actionKind": "webhook", "config": { "targetUrl": "http://example.com", "hasSecret": true, "headers": { "property1": "string", "property2": "string" } }}Path Parameters
ruleId*string
Query Parameters
limit?integer
Delivery attempts to return, newest first.
Range
1 <= value <= 100Default
20Response Body
application/json
curl -X GET "https://example.com/api/v1/webhooks/string/deliveries"[ { "id": "string", "ruleId": "string", "eventType": "record.created", "status": "success", "httpStatus": 0, "detail": "string", "durationMs": 0, "createdAt": "string" }]curl -X POST "https://example.com/api/v1/webhooks/string/test-fire"{ "id": "string", "ruleId": "string", "eventType": "record.created", "status": "success", "httpStatus": 0, "detail": "string", "durationMs": 0, "createdAt": "string"}