Ctrlk
Sprinto DashboardAPI Reference

Create and Manage Webhooks

Learn how to create, configure, and manage ingestion webhooks in Sprinto, including attaching plans, reviewing events, configuring authentication, and troubleshooting incoming requests.

Webhooks allow external systems to send data directly into Sprinto.

Each webhook generates a unique endpoint URL that receives incoming requests from external services.

Webhooks are useful when:

  • External systems send event-based updates

  • Data must reach Sprinto in near real time

  • Workflows depend on incoming alerts or notifications

  • Scheduled polling is not required

You can use webhooks to:

  • Receive incoming payloads

  • Trigger ingestion workflows

  • Process external events

  • Review webhook activity

  • Troubleshoot failed requests

Before You Begin

Ensure that:

  • You have access to the Ingestion module

  • A workflow or integration use case has been identified

  • Required ingestion plans already exist

  • Authentication requirements are known

Open the Webhooks Section

To manage webhooks:

  1. Log in to the Sprinto dashboard.

  2. Go to Ingestion.

  3. Open the Webhooks tab.

The Webhooks page displays all configured webhooks.

Review the Webhooks Dashboard

The Webhooks dashboard displays all webhook configurations.

Each row typically includes:

Column
Description

Name

Webhook name

Description

Optional explanation

Status

Current webhook status

Created At

Creation timestamp

Actions

Opens webhook details

Use this page to review webhook activity and configuration.

Create a Webhook

Create a webhook when an external system needs to send data into Sprinto.

Add a Webhook

  1. Open the Webhooks tab.

  2. Click New Webhook.

  3. Configure the webhook settings.

  4. Click Save.

Sprinto creates the webhook and generates the endpoint URL.

Configure Webhook Information

Webhook creation includes several configuration sections.

Configure Basic Information

Add:

  • Name

  • Description

Use clear names that identify the external system or workflow.

Examples include:

  • Security Alert Webhook

  • Device Sync Webhook

  • Incident Notification Webhook

Configure Authentication

Authentication validates incoming requests before Sprinto processes them.

Authentication settings may include:

  • Tokens

  • Signature validation

  • Secret keys

  • Header-based authentication

The authentication method depends on the external system sending requests.

Configure Advanced Settings

Advanced configuration controls how Sprinto processes incoming payloads.

Advanced settings may include:

  • Event identification

  • Payload validation

  • Parsing behaviour

  • Request handling

These settings help align webhook behaviour with external payload formats.

Configure Rate Limiting

Rate limiting controls how many requests Sprinto accepts within a defined period.

Rate limiting helps:

  • Prevent abuse

  • Improve webhook stability

  • Reduce overload during high-volume activity

Save the Webhook

After configuring the webhook:

  1. Review the configuration.

  2. Click Save.

Sprinto creates the webhook and generates the endpoint URL.

Review Webhook Details

Webhook details provide visibility into configuration and incoming activity.

Open Webhook Details

  1. Locate the required webhook.

  2. Click View.

Sprinto opens the webhook details page.

Review the Webhook URL

Each webhook includes a generated endpoint URL.

External systems must send requests to this endpoint.

You can copy the URL directly from the webhook details page.

Test a Webhook

Sprinto provides testing examples to help validate webhook delivery.

Test Webhook Delivery

  1. Open webhook details.

  2. Review the provided cURL example.

  3. Send a test request to the webhook endpoint.

  4. Confirm the request appears in Recent Events.

Testing helps confirm:

  • Connectivity

  • Authentication

  • Payload delivery

  • Processing behaviour

Attach a Workflow Plan

Webhooks receive incoming requests, but attached plans determine how those requests are processed.

Without a plan, Sprinto may receive events without processing them into ingestion workflows.

Attach a Plan

  1. Open webhook details.

  2. Go to Attached Plans.

  3. Click Attach Plan.

  1. Select the required plan.

  2. Configure optional settings.

  3. Click Attach.

The webhook becomes connected to the ingestion workflow.

Configure Workflow Settings

When attaching a plan, you can configure additional processing behaviour.

Filter Expressions

Filter expressions determine which events should trigger processing.

Use filters to:

  • Ignore unnecessary events

  • Restrict processing

  • Match specific event types

Runtime Parameters

Runtime parameters pass values from the incoming payload into the workflow.

This allows workflows to behave dynamically based on incoming data.

Review Recent Events

The Recent Events section displays webhook activity.

Use Recent Events to confirm whether requests are reaching Sprinto successfully.

Each event may include:

Field
Description

Timestamp

When the request was received

Status

Processing result

Event ID

Unique event identifier

Payload

Incoming request preview

Recent Events help troubleshoot delivery and processing issues.

Edit a Webhook

Webhook configurations can be updated after creation.

Edit Webhook Configuration

  1. Open webhook details.

  2. Click Edit.

  1. Update the required settings.

  2. Click Save.

Changes apply immediately.

Rotate a Webhook ID

Rotating a webhook ID generates a new endpoint URL.

Use rotation when:

  • Endpoint URLs are exposed

  • Security policies require regeneration

  • Existing credentials are compromised

Rotate the Webhook URL

  1. Open webhook details.

  2. Click Rotate ID.

  1. Confirm the action.

Sprinto generates a new endpoint URL.

Important

After rotation, previous webhook URLs stop working immediately.

Delete a Webhook

Delete a webhook when it is no longer required.

Delete a Webhook

  1. Open webhook details.

  2. Click Delete.

  1. Confirm the action.

Deleting a webhook permanently removes the endpoint.

Important

Deleting a webhook:

  • Removes the endpoint

  • Prevents future requests

  • Cannot be undone

Troubleshoot Webhook Issues

Use the following checks when webhook requests fail:

  • Verify the webhook URL

  • Confirm authentication settings

  • Review Recent Events

  • Validate payload format

  • Check rate limiting configuration

  • Test using the provided cURL example

Recent Events usually provide the fastest way to identify failed requests.

When to Use Webhooks

Webhooks are recommended when:

  • External systems support event delivery

  • Real-time updates are required

  • Workflows depend on immediate processing

  • Polling is unnecessary or inefficient

For scheduled retrieval workflows, ingestion plans may be sufficient without webhooks.

Best Practices

Use the following recommendations when configuring webhooks:

  • Use descriptive webhook names

  • Configure authentication whenever possible

  • Attach plans immediately after webhook creation

  • Test webhook delivery before production use

  • Use filters to reduce unnecessary processing

  • Review Recent Events regularly

  • Rotate webhook URLs if exposure occurs

  • Delete unused webhooks

Related Topics

PreviousReview Ingested Data and Entity RecordsNextEdit Workflows Using YAML Editor

Last updated