Integration
This category includes panels related to software integration.
Access Tokens
This panel supports settings for authenticating third party applications through OAuth2. A link is provided detailing how to interact with the API.
Adding an Access Token
Adding an access token is simple:
- Click the Create a token button.
- Enter a name for the access token.
- Click Save.
- The token will now appear. Save this token, as this is the only time you will see it.
- Once saved, click Done.
The application should now appear in the list of applications. By clicking the ⚙ button on the right, you can select Rename to change the name, or Revoke to delete the access token. The access token itself can not be viewed.
Web Hook
Web hooks allows for integrations with other services by sending HTTPS requests in response to certain events.
Adding a Web Hook
The web hook columns include:
| Column | Description |
|---|---|
| Name | the name of the web hook |
| URL | the URL to which the payload will be sent to |
| Last triggered | when this web hook was last triggered |
| State | the state of this web hook |
| Actions | the ⚙ Actions menu button which allows for the web hook to be edited, or deleted |
To add a web hook, simply select the Add a web hook button and specify a name and https URL that the request will be sent to. The web hook will then appear in the list of web hooks which shows its basic details, when it was last triggered and whether it is active or not.
The different columns showing the list of web hooks can also be sorted by clicking on the column heading. Searching is also enabled, through the magnifying glass icon on the right.
Configuring the Web Hook
To configure the web hook, click the desired web hook in the list of web hooks. In the Event Types panel you can select which events that the web hook will trigger in response to. The possible triggers are:
- Organization updated: A user has created an organization, or changed its name.
- User updated: A user has been added to an organization, or changed their name, email address, or telephone number.
In the Options panel, you can specify how the request will be sent. By right clicking the web hook or clicking the ⚙ icon on the right, you can delete the web hook or edit the web hook's name and url.
In the Options panel a variety of options are presented, these being whether to verify SSL, if a signing secret is used, the format of the data, and the max number of events per request.
Payload Format
For each of the event types, information about the payload including an example payload can be seen by clicking the ? icon that appears when hovering over the corresponding event type.
Web Hook History
This shows a list of past requests triggered by your web hooks. The web hook history columns include:
| Column | Description |
|---|---|
| Sent at | the time this web hook was triggered |
| URL | the URL which the payload was sent to |
| Result | the resulting status code |
| Actions | the ⚙ Actions menu button which allows for the web hook to be re-sent |
By clicking on a request, more details about the request can be seen, such as the payload and response headers. A request can be re-sent by right clicking the request or clicking the ⚙ button and clicking Re-send.
The different columns of web hook history table can also be sorted by clicking on the column heading. Searching is also enabled, through the magnifying glass icon on the right.