SIT-14066: Forward Webhook Settings

How to Use This Feature

SEATHQ Webhook Forwarding Feature

Overview

The SEATHQ webhook forwarding feature allows for the automatic forwarding of catchall webhooks to a specified endpoint. This feature enables real-time updates from marketplace and ingest systems.

Behavior

  • When a catchall webhook is triggered, the system evaluates the affiliate's configuration.
  • If both required properties (`webhookForwarding.enabled` and `webhookForwarding.url`) exist:

    • + Log: "Forwarding webhook to"

    + Forward the webhook request using the provided method, headers, retries, and retry delay.

    + Log: "Forwarded to"

  • If either property is missing, do not forward the webhook and log: "Skipping Webhook forwarding"

    • Configuration

    The affiliate's configuration includes a JSON object with the following properties:

  • `webhookForwarding`:

    • + `enabled`: boolean indicating whether forwarding is enabled

    + `url`: URL to forward webhooks to

    + `headers`: optional headers to include in the forwarded request

    + `method`: optional method to use for the forwarded request

    + `retries`: optional number of retries before giving up

    + `retryDelayMs`: optional retry delay in milliseconds

    Testing

    Five test cases are provided:

  • Update affiliate to store forwarding configuration
  • Create a ticket group using an affiliate with webhook forwarding
  • Forward order webhook request when forwarding is enabled
  • Do not forward when affiliate no longer has forwarding configuration
  • Log "Skipping Webhook forwarding" when forwarding is disabled

    • Additional Information

    Status: Pending UAT Deployment
    Assigned to: Matthew Heinke
    🏠 Home View in Jira