Skip to content
English - United Kingdom
  • There are no suggestions because the search field is empty.

API: webhooks integration

Webhooks allow external systems or custom endpoints to receive instant updates when specific events occur within the SpeakUp platform.

Unlike traditional APIs that rely on periodic polling, SpeakUp Webhooks push real-time notifications as soon as issues are created or updated, ensuring timely data delivery and seamless integration with external tools.

Key Features

  • Real-Time Event Delivery — Instantly receive updates the moment an issue is created or updated

  • Flexible Integrations — Connect SpeakUp seamlessly with your internal systems, analytics tools, or third-party applications

  • Enterprise-Grade Security — Secure your webhook communications with encrypted credentials and administrator-only configuration access

Getting Started

Prerequisites

Before setting up webhooks, ensure you have:

  • Webhooks Package Enabled — Your SpeakUp system must have the Webhooks package enabled

  • SpeakUp Administrator Role — You must be logged in as a user with administrative privileges

  • Target System Access — You have access to the destination system's webhook endpoint or API

Setup Process

  1. Prepare the Target System
    Configure and obtain the webhook endpoint (URL) in your target system where SpeakUp will send event notifications.

  2. Create the Webhook in SpeakUp
    As an administrator, set up a new webhook configuration by specifying:

    • Clear name and description

    • Target URL

    • Desired trigger events (Issue Created or Issue Updated)

    • Appropriate authorization type

  3. Set Authentication
    Select the authentication method for your webhook:

    • Basic Auth — Use a username and password for client-managed systems that require secured access

    • No Auth — Use this option if the target system does not require credentials

Notification Triggers

Webhooks can be configured to fire on two types of issue events:

Issue Created

Triggered when a new issue is submitted to SpeakUp. This provides immediate notification of new reports, allowing teams to respond quickly to emerging issues.

Issue Updated

Triggered when an existing issue is modified, including changes to:

  • Domain

  • Status

  • Assignee

  • Summary

  • Resolution

  • Labels

  • Description

  • Draft description

  • Received date / Acknowledged date

  • Due date

  • Data retention settings (status and retention period)

  • Issue type

This keeps teams informed of issue progress and lifecycle changes in real-time.

Integration Types

Client Managed Integration

Configure webhooks to deliver issue data directly to your internal systems, analytics platforms, or third-party applications in JSON format.

Benefits:

  • Complete control over how data is received and processed

  • Support for custom authentication methods

  • Seamless connectivity with your existing infrastructure

Security and Data Protection

Authentication Methods

Client Managed System:

  • Optional Basic Authentication support for your APIs

  • Credentials are encrypted using industry-standard security measures

Data Transmission

  • All webhook data is transmitted over HTTPS/TLS

  • End-to-end encryption during transit

  • Credentials are encrypted at rest using industry-standard encryption

Access Control

  • Only SpeakUp system administrators can set up and manage webhooks

Best Practices

Configuration

  • Use descriptive names and descriptions for webhook configurations to identify their purpose

  • Configure appropriate triggers based on your use case

Monitoring and Maintenance

  • Monitor for delivery failures

  • Update webhook URLs when platforms change

  • Disable webhooks temporarily during maintenance or troubleshooting

  • Re-enable webhooks after issues are resolved

Error Handling

  • Webhook failures don't block core SpeakUp functionality

  • Webhook execution failures are logged in system logs

Limitations and Technical Details

Current Capabilities

  • Issue-centric notifications only (created/updated events)

  • Basic auth and No auth for client managed webhook url or APIs

  • Administrator-only configuration and management

Rate Limits & Performance

  • Webhook requests are subject to standard API rate limits

  • Webhook failures do not block core SpeakUp issue operations

Support and Troubleshooting

Common Issues

  • Expired or invalid webhook URLs

  • Authentication credential changes

  • Network connectivity problems

Future Enhancements

SpeakUp Webhooks will continue to evolve to provide greater flexibility, richer integrations, and enhanced data control.

Customizable Data Fields

Future versions will allow administrators to select exactly which data fields are included in webhook notifications, including:

  • Issue ID

  • Custom ID

  • Summary

  • Description

  • Status

  • Type

  • Created Date

  • Acknowledged Date

  • Assignee

  • Resolution

  • Due Date

Expanded Integration Options

Additional native integrations beyond client-managed systems:

  • Slack Integration — Send rich, formatted messages directly to Slack channels using Slack's Block Kit, with instant notifications and native Slack formatting

  • Microsoft Teams Integration — Send structured, interactive message cards to Teams channels with native authentication and action buttons for streamlined collaboration