For the complete documentation index, see llms.txt. This page is also available as Markdown.

Ticketing App Webhooks

Overview

Fastweigh supports custom payloads that are triggered based on specified ticketing app events.

The payload expects JSON formatting and will automatically append the header:

Content-Type: application/json

Description: Display name for internal reference only.

Priority: 1 is the Highest, 100 is the lowest. Webhook events with the highest priority will run first.

Method: Supports POST, PUT, DELETE and GET

Endpoint URL: External Webhook URL should be entered here.

Event to Trigger: Select the Fastweigh Server Event to trigger the Webhook Event.

Filter Event to Lane: Optionally, events can be filter to a specific lane, if your installation has multiple.

Headers: Additional Headers can be configured, such as an API Key. Content-Type: application/json will be appended automatically.

Payload: Static JSON payload. It is not currently possible to reference fields from events (Such as Ticket Number or Current Scale Weight)

Testing Webhooks

We recommend using Webhook.site to validate webhook functionality during setup and troubleshooting.

Webhook.site automatically generates a unique testing endpoint that can receive and display webhook payloads in real time. This allows you to verify that requests are being sent successfully and to inspect the contents of each payload.

Using Webhook.site

  1. Navigate to Webhook.site.

  2. A unique endpoint URL will be generated automatically. If you have visited the site recently, your previous endpoint may still be active.

  3. Click Edit and Enable "Add CORS Headers" (Top Right)

  4. Click Copy and select URL to copy the generated endpoint.

  5. Paste the copied URL into the Endpoint URL field of your webhook configuration.

  6. Trigger the webhook and monitor Webhook.site to view the incoming requests and payload data.

Payload Requirements

Webhook.site can receive any valid JSON payload. While the site provides example payloads for testing, you may send any JSON-formatted data that meets your application's requirements.

Using Webhook.site is an effective way to confirm webhook connectivity, validate payload structure, and troubleshoot integration issues before connecting to a production endpoint.

If using the payload example:

Fastweigh Configuration should look like:

Manually triggering an event by clicking "Test Event" will send a payload to the webhook.site service:

Last updated