WebHooks
Last updated
Last updated
Retrieves 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)
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
Webhook ID
No content
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
Webhook ID
Retrieves all webhooks configured for the specified repository. Returns detailed information about each webhook including: - GitHub webhook ID and internal ID - Webhook URL endpoint - Events that trigger the webhook - Active status - Creation and last update timestamps
List of webhooks for the repository
Permanently deletes a webhook for the specified repository. This operation: - Removes the webhook from GitHub, stopping all event deliveries - Deletes the webhook metadata from the SFP database - Does not delete the webhook secret (which may be reused if webhook is recreated)
The webhook has been successfully deleted
No content
Processes incoming GitHub webhook events. This is the endpoint that GitHub calls when events occur in the repository. The endpoint: - Validates the webhook signature using the repository's secret - Extracts event type and delivery ID from GitHub headers - Routes the event to appropriate handlers based on event type - Processes events asynchronously to avoid blocking GitHub
The webhook event has been processed successfully
No content
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
Webhook ID
A human-readable name for the webhook
Deploy to Production
The event that triggers this webhook
release.published
Provider-specific configuration
{"repository":"owner/repo","workflow":"deploy.yml","ref":"main"}
Timeout in milliseconds
10000
Number of retry attempts
3
Delay between retries in milliseconds
60000
Current status of the webhook
active
Possible values: Triggers 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
The event that triggers the webhooks
document.created
The event payload
{"id":"doc123","name":"example.md","type":"markdown","createdBy":"user@example.com"}
Webhook deliveries have been queued
Creates 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.
Repository identifier in format owner/repo
octocat/hello-world
URL where GitHub should send webhook events
https://example.com/webhook
Manually 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
Webhook ID
The payload to deliver to the webhook endpoint
{"event":"deployment","environment":"production","status":"success"}
Webhook delivery has been queued
Creates a GitHub webhook for the specified repository to enable real-time event notifications. The webhook listens for a predefined set of events relevant to the SFP application: - pull_request: Tracks PR creation, updates, merges, and closures - pull_request_review: Monitors review submissions and changes - pull_request_review_comment: Captures inline code review comments - issue_comment: Tracks comments on both issues and pull requests - issues: Monitors issue lifecycle events
Repository identifier in format owner/repo
octocat/hello-world
URL where GitHub should send webhook events
https://example.com/webhook
The webhook has been successfully created
Updates an existing GitHub webhook's URL for the specified repository. The webhook must already exist for this repository. The events that trigger the webhook and its active status remain unchanged - only the URL is updated.
Repository identifier in format owner/repo
octocat/hello-world
URL where GitHub should send webhook events
https://example.com/webhook
The webhook has been successfully updated