Webhook


📍 To access Webhook integrations, go to: More > Integrations > Webhook

Overview

RedFlag allows you to send messages through external systems by configuring a Webhook integration. This is useful for triggering messages from third-party tools, automation platforms, or internal applications.

Webhook integrations allow RedFlag to send structured data to an external URL whenever a message is triggered. This setup is ideal for organizations looking to automate workflows or notify external systems when messages are sent from RedFlag.

🛡️ Note: A valid Webhook URL is required to authenticate the request with your external system.

Webhook Integration

Navigate to More > Integrations > Webhook

Fill out the configuration fields as follows:

  • Webhook Name
    • A name for your webhook configuration (e.g., "Facilities Alert Trigger").
  • Webhook URL
    • Enter the full URL of the system that will receive the webhook POST request. This must be an actual webhook endpoint that can receive HTTP POST requests.
    • The receiving endpoint should:
      • Be publicly accessible
      • Accept Content-Type: application/json
      • Parse and respond to a POST request with a JSON payload

🛡️ Note: If you are embedding this into a website or another tool, you cannot simply paste the website URL. It must be a dedicated webhook handler capable of accepting an HTTP POST request with a JSON body. Static page URLs (e.g., from WordPress, Google Sites, or SharePoint) are not valid webhook targets.

  • Webhook Access Key
    • This key is required in the request header for authentication. RedFlag will pass it as AccessKey in the request headers.
  • JSON Body
    • The body of the webhook request that will be sent. This cannot be edited. It includes the following fields:
      {
       "Name": "Test",
       "Message": "This is test message"
      }

Authorized Users

You can choose who can send messages using the webhook:

  • All Users – Any user in your location can send messages using this webhook
  • Selected Users – Limit access to specific users only
  • Select the appropriate option based on your internal access policies.

Send a Message Using the Webhook

Once the webhook is configured:

  • Go to Messages > Create Message
  • Compose your message as usual
  • Under Send Via, select Webhook
  • Choose the webhook you created
  • Click Send Message

RedFlag will transmit the message to the configured Webhook URL using the JSON structure defined: JSON Example: {  "Name": "Test",  "Message": "This is test message" } 

Confirm Delivery

After sending:

  • Check your external system to confirm receipt of the webhook message
  • Review the response from the webhook URL (RedFlag logs response codes for internal monitoring)
  • If needed, review webhook logs or contact your internal IT team to confirm it was processed

Troubleshooting

IssueSolution
Webhook not firingConfirm the URL is accessible and correct
No data received by external systemCheck for authentication issues or access key mismatch
Error response from the endpointReview logs and verify the endpoint accepts the structure you provided