Skip to main content

Notification Settings

This section inroduces how to set notifications for team members in Apidog.

External Notifications

External Notifications enables notifications to be integrated with third-party applications. Based on notification requirements, notification events can be configured. Currently, the supported notification channels include Slack, Webhook and Jenkins.

Usage Scenarios

Integrating notifications with a third-party application sends notifications in real-time to the third-party application platform when a project member triggers the corresponding notification event.

Configuration Instructions

Only project managers can configure it. The notification events supported by each third-party application platform vary, so the configuration items for each third-party application's notification events also differ.

Slack

Apidog supports sending notification events to a specific Channel in Slack by integrating Slack apps - Incoming WebHooks in the specified Channel and configuring the Webhook URL of Incoming WebHooks, which can send event messages to the Slack Channel.

Configuration field description:

Configuration FieldRequiredDescription
Notification NameNoGive a name to the third-party integrated notification to record its purpose.
Trigger EventsYesSupported events API changes, Data model changes, Document changes, Import data, Automation testing
Service URLYesWebhook URL in 「Incoming WebHooks - Integration Settings」

Bind Slack Specific Channel

Project administrators can use third-party integration functions to associate Slack apps - Incoming WebHooks added in Slack - Channels with project notification events in Apidog to push related API changes, documentation changes, testing completions, etc. to the specified Channel in Slack.

  1. In the Integrations - Apps of the specific Channel, install and add Incoming WebHook.

  1. After installation is complete, click the button to the right of Incoming WebHooks - View.

  1. This will open the description page of Incoming WebHooks, click Configuration to set up.

  1. Click Add to Slack.

  1. Select the Channel to push Apidog notification event messages to, and click Add Incoming WebHooks integration.

  1. Get and copy the Webhook URL.

  1. Creating a new notification event

    Click "Settings" > "Notifications" > "External Notifications" > and create a new notification event.

    1. Fill in the notification name.
    2. Select the triggering event.
    3. Choose Slack as the channel.
    4. Paste the Webhook URL obtained from the Incoming WebHooks settings in the Service URL.

After clicking Save, the binding is complete. When the selected event is triggered, a notification will be received in the corresponding Slack Channel:

Webhook

Supports sending notification events to the HTTP Server. You can send event messages to the HTTP Server by specifying a URL address to receive POST requests.

Configuration field description:

Configuration FieldRequiredDescription
Notification NameNoGive a name to the third-party integrated notification to record the purpose of the notification.
Trigger EventYesSupported eventsAPI changesData model changesDocument changesImport dataAutomation testing
Server URLYesURL address of the HTTP Server for receiving requests
Signature AuthNoThe sent content is encrypted by the HMAC SHA1 encryption algorithm, using a token as the KEY to display the value in hexadecimal (requires a configured token), and contains the prefix sha1=

Binding Self-hosted HTTP Server

Project administrators can use third-party integration to associate their self-hosted HTTP Server with project notification events in Apidog, to receive notifications for relevant API changes, document changes, and automation test completions in their HTTP Server.

Creating a new notification event

Click "Settings" > "Notifications" > "Third-party" > and create a new notification event.

  1. Fill in the notification name.
  2. Select the triggering event.
  3. Choose Webhook as the channel.
  4. Paste the URL of the self-hosted HTTP Server in the Service URL field.
  5. If the signature verification is enabled, copy and paste the key in the Signature Key field.

After saving, the binding is completed. When the selected event is triggered, a notification will be received in the HTTP Server.

Jenkins

It supports sending notification events to Jenkins service. By configuring Jenkins Webhook URL, event messages can be sent to Jenkins.

Configuration field instructions:

Configuration FieldRequiredDescription
Notification NameNoGive a name to the third-party integration notification to record its purpose.
Trigger EventsYesAPI changesData model changesImport dataAutomation testingReal-time notifications will be triggered when any of the above events occur.
Service URLYesThe URL is configured in the Generic Webhook Trigger plugin.
Signature AuthNoSent to the Generic Webhook Trigger plugin via the Authorization Bearer header.

Binding Jenkins Service

Project administrators can use third-party integration functionality to associate the Webhook URL configured in the Jenkins Generic Webhook Trigger plugin with project notification events in Apidog, to trigger a build action in Jenkins automatically when events such as API changes, document changes, and automation test completions are triggered, and view messages in the build history.

  1. Webhook URL configured in Jenkins Generic Webhook Trigger plugin

Create a new view on the Jenkins Dashboard:

Click on the view in the previous step to enter Configure>Build Triggers, and select Generic Webhook Trigger. Webhook URL is "http://"+"your service address"+"/generic-webhook-trigger/invoke"

The custom token is supported:

  1. Create a new notification event

InSettings>Third-Party Integrations, click on Create New:

  1. Fill in the notification name
  2. Select the triggering event
  3. Choose Jenkins as the channel
  4. Paste the Webhook URL configured in the Generic Webhook Trigger plugin in the Service URL field
  5. If a custom token is used, copy and paste the Token into the Signature Token field.

After saving, the binding is completed. When the selected event is triggered, Jenkins will automatically initiate a build action and view the message in the build history: