This guide explains what each field is for when configuring your integration.
Integrations are only visible on the 'Manage Integrations' page to all users in your organisation if you Enable your integration.
The name of your integration. This is shown to users of your integration on the manage integrations page in the main app.
Setting the name.
How the name appears in the list of integrations the user sees on the manage integrations page.
This explains to the user what the integration does. This is visible when user's view the page for your integration on the manage integrations page.
Setting the description.
How the description appears on a user's management page for your integration if the integration does not require authentication.
How the description appears on a user's management page for your integration if the integration requires authentication and the user has not yet connected their account.
This is only shown to users for intgrations that require authentication. It should summarise what feed events they will receive from the external service your integration links to.
Setting the field.
How this field is displayed to users when viewing the integration on the manage integrations page.
Each post category has two fields, Category Id and Description. The Id is what is sent in the
category field when calling the Send Feed Event endpoint. The description is displyed to the user on the integration management page next to a toggle. The toggle allows the user to choose whether or not they want to receive feed events in that category from that integration.
Setting the Id and description for a category.
How the category appears to a user when viewing your integration.
Here you can set the Proxy URL and Proxy Secret for your integration, to find out more about how these fields are used, please read Using the proxy endpoint.
To use the API, you need to generate a token for your integration.
You can have up to two tokens active at one time allowing you to generate a second token then migrate your integration's code to using it.
To use a token, simply copy it from the text box and send it in any requests to the API as an
Authorization header with the value
Bearer <your token>.
Updated about a year ago