Main Concepts
Learn about how Zapier works by familiarising with its main concepts.
Before getting started, familiarising with a few main concepts will help you understand how Zapier works and how workflows are built.
🔑 API token
When creating your integration, Zapier will need permission to access your Claimable account and connect to it. To do so, you will need to provide a unique API token.
It is best practice to use one API token per integration (Zap). This way, if you ever need to revoke access, you can do so without disrupting other integrations or projects that might otherwise be sharing the same API token.
Request an API token
You can request an API token via customer support at [email protected] or use the in-app chat and we'll issue a token so you can start making API requests right away.
⚡️Zap
A Zap is an automated workflow between two or more systems. For example, you may have a Zap that creates a contact in Claimable every time a new lead is added to a spreadsheet and another Zap that sends claim data to a Slack channel every time a claim is created.
Zaps consist of at least two parts: a trigger and one or more action.
🪃 Trigger
A trigger is the event that starts the Zap. Examples of a trigger can be: a contact being saved in a spreadsheet or, a new claim being created in Claimable. Once you publish a Zap, Zapier will monitor the app in question (e.g.: Google Sheets or Claimable) for trigger events, starting the workflow every time the trigger happens.
We have created some default Claimable triggers for you to use, but you can use triggers from other software or build your own using the available Claimable's webhook events.
Available pre-defined Claimable triggers in Zapier:
| Triggers | Explanation |
|---|---|
| New Claim Created | Triggers an action when a new Claim is created. |
| Claim Closed | Triggers an action when a Claim is closed. |
| Supplier Appointed | Triggers an action when a Supplier is appointed to a Claim. |
| New Claim Payment Created | Triggers an action when a new Payment is created on a Claim. |
Note
If the pre-defined triggers are not what you are looking for, you can use any of Claimable's webhook events to create triggers via the Webhooks by Zapier option.
🔗 Webhook URL
The webhook URL is used by Zapier to listen to trigger events happening in Claimable. When using a Claimable trigger, Zapier will provide you with a URL. You will just need to copy that and send it to us via customer support at [email protected] or use the in-app chat. We will configure this for you right away.
💪 Action
An action is the event that completes the Zap. For example, the action could be to create a contact in Claimable or to add a note to an existing claim.
We have created some default actions for you to use, but you can use pre-existing actions from other software or build your own via the available Claimable API endpoints.
Available pre-defined Claimable actions:
| Action | Explanation |
|---|---|
| Add a Label to a Claim | Adds an existing Label to a Claim. |
| Create a Claim | Creates a new Claim in Claimable. |
| Create a Contact | Creates a new Contact in Claimable. |
| Create a Note on a Claim | Creates a Note on a Claim. |
| Get a Claim | Fetches an existing Claim. |
Note
If the pre-defined actions are not what you are looking for, you can use any of Claimable's endpoints to create actions via the Webhooks by Zapier option.
Updated about 1 month ago