Source: https://atomic-works-test.docs-staging.pageloop.ai/ingestion/dashboard-actions/create-and-manage-webhooks # Create And Manage Webhooks --- description: >- Learn how to create, configure, manage, and monitor ingestion webhooks in Sprinto, including authentication, attached plans, recent events, webhook testing, and lifecycle actions. --- # Create and Manage Webhooks Webhooks allow external systems to send data directly into Sprinto. Each webhook generates a unique endpoint URL that can receive incoming requests from external services. Webhooks are commonly used when: * Data must be pushed into Sprinto automatically * Events occur outside scheduled ingestion plans * External systems support webhook delivery * Near real-time processing is required Within Sprinto, webhooks can be configured with: * Authentication rules * Rate limiting * Attached ingestion plans * Event filtering * Runtime parameters * Event visibility *** ## Before You Begin Ensure that: * You have access to the **Ingestion** module * A webhook use case has been identified * Any required ingestion plans already exist * Authentication requirements are known *** ## Access the Webhooks Page To manage webhooks: 1. Log in to the Sprinto dashboard. 2. Go to **Ingestion**. 3. Select the **Webhooks** tab.
The Webhooks page displays all configured webhooks. *** ## Understand the Webhooks Dashboard The Webhooks dashboard lists all available webhooks. Each row typically includes:
ColumnDescription
NameWebhook name
DescriptionOptional explanation
StatusCurrent webhook state
Created AtCreation timestamp
ActionsOpens webhook details
Use the dashboard to monitor existing webhook configurations. *** ## Create a Webhook Create a webhook when you need Sprinto to receive data from an external source. ### Add a Webhook 1. Open the **Webhooks** tab. 2. Click **New Webhook**. 3. Configure webhook settings.
The webhook becomes available immediately. *** ## Configure Webhook Details Webhook creation includes multiple configuration sections. *** ## Basic Information Configure: * Webhook name * Description Use descriptive naming to identify the source system. Examples include: * Incident Events * Device Sync Webhook * Security Alert Feed
*** ## Authentication Authentication validates incoming requests. Authentication ensures that only trusted systems can send data. Authentication configuration may include: * Secret keys * Signature validation * Header mapping * Token validation The authentication method depends on the external system.
*** ## Advanced Configuration Advanced settings define how Sprinto processes webhook requests. Advanced configuration may include: * Payload handling * Event identification * Challenge validation * Custom parsing rules These settings help align the webhook with external payload formats.
*** ## Rate Limiting Rate limiting controls how many requests Sprinto accepts. Rate limiting helps: * Prevent abuse * Avoid overload * Improve webhook stability Rate limits can be configured during webhook creation or editing.
*** ## Save a Webhook After configuring all sections: 1. Review the configuration. 2. Click **Save**.
Sprinto creates the webhook and generates a webhook URL. *** ## View Webhook Details Webhook details provide access to configuration and event activity. ### Open Webhook Details 1. Locate a webhook. 2. Click **View**.
Sprinto opens the webhook details page. *** ## Webhook Details Overview The details page includes: * Configuration summary * Webhook URL * Attached plans * Recent events * Testing utilities * Lifecycle actions
*** ## View the Webhook URL Each webhook includes a generated endpoint URL. External systems must send requests to this endpoint. The URL is visible from the webhook details page. *** ## Test a Webhook Webhook testing helps validate connectivity. Sprinto provides a cURL testing section to help verify requests. ### Test a Webhook 1. Open webhook details. 2. Review the test request example. 3. Send a request to the webhook endpoint. 4. Confirm event visibility. Testing helps confirm that payloads reach Sprinto successfully. *** ## Attach a Plan to a Webhook Attached plans determine how webhook payloads are processed. Without a plan, webhook requests may be received but not processed into ingestion workflows. ### Attach a Plan 1. Open webhook details. 2. Go to **Attached Plans**. 3. Click **Attach Plan**. 4. Select a plan. 5. Configure optional settings. 6. Click **Attach**.
The plan becomes associated with the webhook. *** ## Configure Attached Plan Settings When attaching a plan, you can configure additional behaviour. ### Filter Expression Filter expressions control whether incoming events should trigger processing. Use filters to: * Restrict processing * Ignore unnecessary payloads * Match specific event types ### Runtime Parameters Runtime parameters pass values from the payload into the plan. This allows dynamic execution based on incoming data. *** ## View Recent Events Recent events display webhook activity. This helps confirm whether requests are reaching Sprinto. ### Recent Event Information Each event may include:
FieldDescription
TimestampWhen the request was received
StatusProcessing result
Event IDUnique event identifier
PayloadIncoming request preview
Recent events are useful for troubleshooting. *** ## Edit a Webhook Webhook configurations can be updated after creation. ### Edit a Webhook 1. Open webhook details. 2. Click **Edit**.
3. Update the required configuration. 4. Click **Save** to save the changes.
Updates apply immediately. *** ## Rotate Webhook ID Rotating a webhook ID generates a new endpoint URL. Use rotation when: * Credentials are compromised * Endpoint URLs must be refreshed * Security policies require regeneration ### Rotate a Webhook ID 1. Open webhook details. 2. Click **Rotate ID**.
1. Confirm the action. Sprinto generates a new webhook URL. ### Important After rotation: * Old URLs stop working * External systems must update the endpoint * Requests sent to the previous URL fail *** ## Delete a Webhook Delete a webhook when it is no longer required. ### Delete a Webhook 1. Open webhook details. 2. Click **Delete**.
3. Confirm the action. The webhook is permanently removed. {% hint style="warning" %} #### Important Deleting a webhook: * Removes the endpoint * Prevents future requests * Cannot be undone {% endhint %} *** ## Webhook Workflow A typical webhook lifecycle follows this sequence: 1. Create a webhook. 2. Configure authentication. 3. Define advanced settings. 4. Save the webhook. 5. Share the endpoint URL. 6. Attach a plan. 7. Receive incoming requests. 8. Monitor recent events. 9. Update or rotate configuration when needed. *** ## Best Practices Use the following recommendations when managing webhooks: * Use descriptive webhook names * Configure authentication whenever possible * Attach plans immediately after creation * Test webhook delivery before production use * Use filters to reduce unnecessary processing * Review recent events regularly * Rotate webhook IDs if exposure occurs * Delete unused webhooks *** ### Related Information * [Create and Configure an Ingestion Plan](create-and-configure-an-ingestion-plan.md) * [Manage Plan Execution and Version History](manage-plan-execution-and-version-history.md) * [Build and Edit Plans Using YAML and AI Editor](build-and-edit-plans-using-yaml-and-ai-editor.md) * [Create and Manage Entity Types](create-and-manage-entity-types.md)