Webhooks configuration

Step 1: Accessing Webhook Settings

1. Log in to the platform and navigate to the Settings section in the side menu.

2. In Settings, you will find an input field labeled URL. Enter the webhook URL here, where you would like to receive notifications.

Step 2: Selecting Tables to Listen For

1. Just below the URL input, you’ll find the Select Tables for Webhook field.

2. In this field, select the tables you wish to listen to. These tables represent the data updates you are interested in receiving through the webhook.

Step 3: Receiving Data Updates

Once you have configured the webhook URL and selected the tables, any updates to these tables will trigger a notification to your webhook. You can then use Shield API to retrieve the specific data that has been updated, ensuring accurate and real-time integration. Once the webhook is configured, any update in the selected tables will trigger a notification with the following information:

1. type: Indicates whether the record was inserted or updated.

2. id: The unique identifier of the affected record.

Step 5: Example response

Example Response Explanation

The message field is constructed as follows:

A ${table} was ${actionMessage}.

Where:

• table can be one of the following values:

  • claims

  • risk_items

  • claims_events

  • orders

• actionMessage can be:

  • updated

  • inserted

Examples

• If table = "claims" and action = "updated", the message will be:

  "A claims was updated."

• If table = "orders" and action = "inserted", the message will be:

  "A orders was inserted."

Risk Item response

{
  "message": "A risk_items was updated.",
  "id": "0279c19a-f704-4998-9763-4122a0289fdf",
  "messageType": "risk_items"
}

Claims response

{
  "message": "A claims was updated.",
  "id": "0512a58d-17ce-4134-a54e-9d2a055cf2a7",
  "messageType": "claims"
}

Claims events response

{
  "message": "A claims_events was updated.",
  "id": "3f37463e-1550-4e4d-acc0-55b68dca6812",
  "messageType": "claims_events"
}

Orders response

{
  "message": "A orders was updated.",
  "id": "7a9a1670-25c4-4ea7-8d8d-d465f35a28d3",
  "messageType": "orders",
  "idOrder": "00613797-89b9-4b80-9d6b-dcb9422c8e51"
}

Note: The id in this response refers to the associated Risk Item rather than the order itself.