Webhook Events

You can setup as many webhook endpoints as you need. Each endpoint can subscribe to one or more events. Therefore you could have one endpoint that handles all events or a separate one for each, or group related events into their own webhook endpoints.

Available Events

As activity occurs in your organisation's Claimable account, we will make a HTTP request to your webhook endpoint/s when any of the following events happen. All are optional, but there must be at least one event per endpoint to trigger requests.

Webhook events can be triggered from the following sources and this can be defined on a per-endpoint basis.

Claims:

Contacts:

Companies:

📘

Contact Support to Setup Your Webhook Endpoints

Please contact us via the support chat or email [email protected] to request one or more webhook endpoints to be configured on your account. For each endpoint, please provide the following information:

• The URL of your endpoint. And;
• The events you'd like it to be subscribed to.

Webhook Request Payload

When we send a request to one of your webhook endpoints, we include information about what triggered the event, in both the JSON payload as an event_name attribute and as a HTTP Header called Event-Name.

In the response payload we also include metadata about who triggered the event and whether it was via the API or from user activity in the Claimable user interface.

Event Metadata Attributes

For every request we make to one of your webhook endpoints, we include the object that is the subject of the event (e.g. claim, contact) in addition to the following metadata:

Examples of JSON Payload

For the claim webhook event "claim.assigned", performed by a user via the UI:

{
  "claim": {...} // Claim object
  "event_name": "claim.assigned",
  "source": "ui",
  "performed_by":
    "user_id": 2642
    "name": "John Smith"
  }        
}

For the claim webhook event "claim.created", performed via the API:

{
  "claim": {...} // Claim object
  "event_name": "claim.created",
  "source": "api",
  "performed_by":
    "name": "Mobile App API Token"
  }        
}

For the contact webhook event "contact.created", performed by a user via the UI:

{
  "contact": {...} // Contact object
  "event_name": "contact.created",
  "source": "ui",
  "performed_by":
    "user_id": 2642
    "name": "John Smith"
  }   
}

Example of HTTP Header

For the claim webhook event "claim.created":

Event-Name: "claim.created"