How to create a webhook

WHEN TO USE THIS

Use this guide if:

• You want Factbird to notify another system when an event occurs.
• You are integrating Factbird with an external application.
• You want to automate workflows using production events.
• You need to send batch information to another platform.

PREREQUISITES

Before starting:

• You have administrator access to Factbird.
• You have the URL of the endpoint that will receive the webhook.
• If required, you have any authentication credentials (such as an API key or bearer token).
• The receiving system is configured to accept HTTPS POST requests.

STEPS

1. Open the Webhooks page

• Go to Administration.
• Navigate to Webhooks.

2. Create a new webhook

• Click Create Webhook.
• Enter a descriptive name for the webhook.
• Optionally add a description explaining its purpose.

Tip

Use names that clearly identify the integration, such as ERP – Batch Started or MES – Batch Completed.

3. Configure the endpoint

• Enter the HTTPS URL that should receive the webhook.
• Verify that the endpoint is accessible from the internet.

4. Add authentication headers (optional)

If the receiving system requires authentication:

• Add one or more HTTP headers.
• Enter the required header name and value.

Example

5. Select the trigger event

Choose the event that should send the webhook.

Currently supported events include:

• Batch Started
• Batch Ended

6. Select the scope

Choose where the webhook should apply.

Depending on your configuration, this may include:

• Organization
• Site
• Production line

Only events within the selected scope will trigger the webhook.

7. Save the webhook

• Review the configuration.
• Click Save.

The webhook becomes active immediately.

8. Test the webhook

Trigger the selected event.

For example:

• Start a batch if the webhook listens for Batch Started.
• Complete a batch if the webhook listens for Batch Ended.

Verify that the receiving application receives the JSON payload.

9. Review the execution history

Open the webhook.

Review the execution history to confirm:

• Successful deliveries.
• Failed deliveries.
• HTTP response codes returned by the receiving system.

Use this information when troubleshooting integration issues.

EXPECTED RESULT

After completing these steps:

• A webhook has been created.
• Factbird automatically sends an HTTP POST request when the selected event occurs.
• The receiving application receives the JSON payload for further processing.

TROUBLESHOOTING

Issue: The webhook is not triggered.

• Try: Verify that the correct trigger event has been selected.

• Try:Confirm the event occurred within the configured scope.
• Try: Ensure the webhook is enabled.

Issue: The receiving system does not receive the request.

• Try: Verify the endpoint URL is correct.

• Try: Confirm the endpoint is publicly accessible.
• Try: Check any firewall or network restrictions.
• Try: Review the execution history for HTTP error codes.

Issue: Authentication fails.

• Try: Verify the HTTP headers are configured correctly.

• Try: Confirm any API keys or bearer tokens are valid.
• Try: Check the authentication requirements of the receiving system.

Issue: The webhook returns an error response.

• Try: Review the HTTP response code in the execution history.

• Try: Verify the receiving application accepts the JSON payload sent by Factbird.

• Try: Check the receiving application's logs for additional details.

   

STILL NEED HELP?

Contact Support and include:

• The webhook name.
• The configured endpoint URL.
• The trigger event.
• Any HTTP response codes shown in the execution history.
• A description of the issue.

RELATED ARTICLES

• Webhooks