Webhooks
sfp server API reference for Webhooks: 10 endpoints.
/sfp/api/webhooksCreates a new webhook configuration for receiving notifications about system events. Webhooks allow external systems to be notified when specific events occur within the SFP platform.
The webhook configuration includes:- URL endpoint to receive HTTP POST requests- Events to subscribe to (e.g., deployment.started, deployment.completed)- Optional headers for authentication- Active/inactive status- Retry configuration for failed deliveriesEach webhook is associated with the creating account and can only be managed by users with owner role in that account.Authorization
access-token In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/sfp/api/webhooks" \ -H "Content-Type: application/json" \ -d '{ "name": "Simple Webhook", "event": "user.created", "provider": "http", "config": { "url": "https://api.example.com/webhook", "method": "post", "headers": { "Content-Type": "application/json", "X-API-Key": "your-api-key" } } }'{ "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Deploy to Production", "event": "release.published", "provider": "github", "config": { "url": "string", "method": "get", "headers": {}, "filter": {} }, "timeout": 10000, "retryCount": 3, "retryDelay": 60000, "status": "active", "lastDeliveryAt": "2025-01-22T07:42:09.000Z", "errorCount": 0, "createdBy": "john.doe@example.com", "createdAt": "2025-01-22T07:42:09.000Z", "updatedAt": "2025-01-22T07:42:09.000Z"}/sfp/api/webhooksRetrieves all webhook configurations for the current account. Returns detailed information about each webhook including: - Webhook ID and name - URL endpoint - Subscribed events - Active/inactive status - Creation and last update timestamps - Delivery statistics (success/failure counts)
Only webhooks belonging to the authenticated user's account are returned. Requires owner role to view webhook configurations.Authorization
access-token In: header
Response Body
application/json
curl -X GET "https://example.com/sfp/api/webhooks"[ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Deploy to Production", "event": "release.published", "provider": "github", "config": { "url": "string", "method": "get", "headers": {}, "filter": {} }, "timeout": 10000, "retryCount": 3, "retryDelay": 60000, "status": "active", "lastDeliveryAt": "2025-01-22T07:42:09.000Z", "errorCount": 0, "createdBy": "john.doe@example.com", "createdAt": "2025-01-22T07:42:09.000Z", "updatedAt": "2025-01-22T07:42:09.000Z" }]/sfp/api/webhooks/event-catalogReturns the merge fields a webhook body template can reference via { "$path": "" }, keyed by the event a webhook subscribes to. This is the single source of truth for the reference panel and editor autocomplete, so the fields offered in the UI always match what the server actually emits for each event.
Authorization
access-token In: header
Response Body
curl -X GET "https://example.com/sfp/api/webhooks/event-catalog"/sfp/api/webhooks/{id}Retrieves detailed information about a specific webhook configuration. Returns comprehensive webhook details including: - Complete configuration (URL, headers, events) - Delivery statistics and recent delivery history - Active/inactive status and last state change - Retry configuration and backoff settings
This endpoint is useful for debugging webhook delivery issues or verifying webhook configuration. Requires owner role.Authorization
access-token In: header
Path Parameters
Webhook ID
Response Body
application/json
curl -X GET "https://example.com/sfp/api/webhooks/string"{ "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Deploy to Production", "event": "release.published", "provider": "github", "config": { "url": "string", "method": "get", "headers": {}, "filter": {} }, "timeout": 10000, "retryCount": 3, "retryDelay": 60000, "status": "active", "lastDeliveryAt": "2025-01-22T07:42:09.000Z", "errorCount": 0, "createdBy": "john.doe@example.com", "createdAt": "2025-01-22T07:42:09.000Z", "updatedAt": "2025-01-22T07:42:09.000Z"}/sfp/api/webhooks/{id}Updates an existing webhook configuration. All fields are optional - only provided fields will be updated. Common updates include: - Changing the endpoint URL - Adding/removing subscribed events - Updating authentication headers - Enabling/disabling the webhook - Modifying retry configuration
The webhook must belong to the authenticated user's account. Updates take effect immediately for new event deliveries. Requires owner role.Authorization
access-token In: header
Path Parameters
Webhook ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://example.com/sfp/api/webhooks/string" \ -H "Content-Type: application/json" \ -d '{ "config": { "url": "https://new-api.example.com/webhook", "method": "post", "headers": { "Content-Type": "application/json", "X-New-Header": "new-value" } } }'{ "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Deploy to Production", "event": "release.published", "provider": "github", "config": { "url": "string", "method": "get", "headers": {}, "filter": {} }, "timeout": 10000, "retryCount": 3, "retryDelay": 60000, "status": "active", "lastDeliveryAt": "2025-01-22T07:42:09.000Z", "errorCount": 0, "createdBy": "john.doe@example.com", "createdAt": "2025-01-22T07:42:09.000Z", "updatedAt": "2025-01-22T07:42:09.000Z"}/sfp/api/webhooks/{id}Permanently deletes a webhook configuration. This action: - Stops all future event deliveries to this webhook - Cancels any pending retries for failed deliveries - Removes the webhook configuration from the system - Retains historical delivery logs for audit purposes
This operation cannot be undone. The webhook must belong to the authenticated user's account. Requires owner role.Authorization
access-token In: header
Path Parameters
Webhook ID
Response Body
curl -X DELETE "https://example.com/sfp/api/webhooks/string"/sfp/api/webhooks/{id}/deliveriesReturns recent delivery attempts for a webhook — status, event, HTTP response code, error message, timing and attempt count — plus success/failure totals. The debug surface for a webhook: see exactly what was sent and what came back. Requires owner role.
Authorization
access-token In: header
Path Parameters
Webhook ID
Query Parameters
Response Body
curl -X GET "https://example.com/sfp/api/webhooks/string/deliveries?status=string&limit=string&cursor=string&responseStatus=string&from=string&to=string"/sfp/api/webhooks/{id}/deliveries/{deliveryId}/attemptsReturns every physical HTTP try made for a delivery — attempt number, response code, error, sent body, response body/headers, duration and timestamps — newest attempt first. This is the retry history behind a single delivery. Requires owner role.
Authorization
access-token In: header
Path Parameters
Webhook ID
Delivery ID
Response Body
curl -X GET "https://example.com/sfp/api/webhooks/string/deliveries/string/attempts"/sfp/api/webhooks/{id}/deliverManually queues a custom payload for delivery to a specific webhook. This endpoint is useful for: - Testing webhook connectivity and payload handling - Replaying failed deliveries with corrected data - Sending custom notifications outside normal event flow
The payload is queued for asynchronous delivery and will follow the webhook's retry configuration if delivery fails. Returns a delivery ID for tracking. Requires owner or application role.Authorization
access-token In: header
Path Parameters
Webhook ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/sfp/api/webhooks/string/deliver" \ -H "Content-Type: application/json" \ -d '{ "payload": { "event": "user.notification", "message": "Hello World", "timestamp": "2026-09-16T00:49:51.929Z" } }'{ "success": true, "statusCode": 0, "error": "string", "duration": 0, "message": "string", "providerDetails": { "method": "get", "url": "string", "headers": {}, "filtered": true, "templateError": true, "queued": true, "deliveryId": "string", "notFound": true, "eventName": "string", "webhookId": "string", "reason": "string", "response": {}, "sentBody": {} }}/sfp/api/webhooks/triggerTriggers webhook deliveries for all active webhooks subscribed to a specific event. This endpoint: - Finds all active webhooks subscribed to the specified event - Queues the payload for delivery to each matching webhook - Processes deliveries asynchronously with configured retry policies - Returns delivery IDs for tracking each webhook delivery
This is the primary mechanism for event-driven webhook notifications in the system. Useful for manual event triggering or system integrations. Requires owner or application role.Authorization
access-token In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/sfp/api/webhooks/trigger" \ -H "Content-Type: application/json" \ -d '{ "event": "user.created", "payload": { "userId": "123", "action": "created", "timestamp": "2026-09-16T00:49:51.929Z" } }'[ { "success": true, "statusCode": 0, "error": "string", "duration": 0, "message": "string", "providerDetails": { "method": "get", "url": "string", "headers": {}, "filtered": true, "templateError": true, "queued": true, "deliveryId": "string", "notFound": true, "eventName": "string", "webhookId": "string", "reason": "string", "response": {}, "sentBody": {} } }]