Trébol uses webhook notifications to inform you about new events regarding your Verification Requests. For example, we will send you a webhook notification each time a Business Verification Request is Completed. We also use notifications in Slack to keep your operations team in the loop. Talk to us if you need us to send a notification to another platform. You can use these notifications to trigger tasks according to each event.

Our Webhooks notifications are sent via HTTPS and will have a JSON payload with an Event Object.

To set up a new webhook, use the Trebol console.

The Event Object

Each time Trebol sends you a webhook, it will contain an Event Object with the event's data. The data field structure will depend on the type of event. In the following sample, we have an event of type verification.finished and the data will have the Verification Object structure

{
  "id": "2d9f6acc-45bc-2ae1-a13a-eb404187f30e",
  "object": "event",
  "created": 1639754959,
  "type": "verification.finished",
  "data": {
    "id": "the-verification-id",
    "created_at": "2024-10-23T16:48:34.713Z",
    "country": "mx",
    "status": "finished",
    "tax_id": "some-tax-id",
    "metadata": {
      "some": "value"
    },
    "items": [
      {
        "item_id": "some-item-id",
        "item_type": "ac_mx",
        "item_value": {}
      }
    ]
  }
}