Overview
Integrations connect your Faylee workspace to the tools your team already uses. Once one is connected, a recording can become an issue in your tracker, show up in a Slack channel, land as a note on a support ticket, or bring along the errors your backend reported while it was made.
Integrations belong to the workspace, not to one person. Workspace admins connect and manage them under Settings, Integrations. Everyone in the workspace then uses them from the recordings they work on.
What integrations do
Section titled “What integrations do”The Integrations page groups providers by what they do.
| Group | What it does |
|---|---|
| Issue trackers | Create an issue from any recording, with the steps, errors and a link filled in. Comments and status can flow back to the recording. |
| Notifications | Post each new recording to a Slack channel. The Slack app also turns thread replies into comments. |
| Help desks | When a recording comes in from a link made for a ticket, add it to the ticket as an internal note. |
| Backend | Match failed requests to the errors your servers reported, by trace id. |
The Notifications group also has a Webhooks card. It leads to the webhooks page, where you send signed events to your own endpoints. See Webhooks.
Every provider
Section titled “Every provider”| Provider | Group | One-click connect | Connect with keys | Details |
|---|---|---|---|---|
| Linear | Issue tracker | Yes | Personal API key | Issue trackers |
| GitHub | Issue tracker | Yes, as a GitHub App | Access token | Issue trackers |
| Jira | Issue tracker | Yes | Account email and API token | Issue trackers |
| GitLab | Issue tracker | Yes, for GitLab.com | Access token, also for self-hosted GitLab | Issue trackers |
| Azure DevOps | Issue tracker | Yes, with a Microsoft work account | Personal access token | Issue trackers |
| ClickUp | Issue tracker | Yes | Personal API token | Issue trackers |
| Notion | Issue tracker | Yes | Integration secret | Issue trackers |
| Asana | Issue tracker | Yes | Personal access token | Issue trackers |
| Trello | Issue tracker | Yes | API key and token | Issue trackers |
| Slack | Notifications | No | Incoming webhook URL | Slack |
| Slack app | Notifications | Yes | Bot token and signing secret | Slack |
| Sentry | Backend | Yes | Auth token | Sentry |
| Zendesk | Help desk | Yes | Agent email and API token | Zendesk and Intercom |
| Intercom | Help desk | Yes | Access token | Zendesk and Intercom |
Connecting
Section titled “Connecting”Each provider has a card on the Integrations page. There are two ways to connect, and the card shows which ones are offered.
One click
Section titled “One click”When one-click connect is offered, the card shows Connect and Use an API key. Connect sends you to the provider to sign in and allow Faylee. Nothing is saved until the provider answers.
When you come back, Faylee opens Finish setting up, where you choose where Faylee works: a team, repository, project, list, database or channel. Faylee fills the choices from the provider. A setting it can’t list is typed in. Save checks the connection with the provider. If you close the dialog with Later, the card shows Finish setup until you return to it.
Zendesk signs you in on your own Zendesk address, so Connect first asks for your subdomain, the acme in acme.zendesk.com.
A one-click connection to an issue tracker also sets up the webhook that brings comments and status changes back to Faylee, so there is nothing to paste.
API keys and tokens
Section titled “API keys and tokens”Use an API key, or Connect on a card without one-click connect, opens a form for the provider’s credentials and settings. Each field has a hint that says where to find the value in the provider. Faylee checks the details with the provider before it saves them. If the provider refuses, you see its reason and nothing is saved.
Secret fields are stored encrypted and never sent back to the browser. When you edit a connection, secret fields start empty and keep their value if you leave them empty.
For an issue tracker or the Slack app connected this way, the card shows a webhook address to add in the provider, so comments and status changes come back to Faylee. See Two-way sync.
Checking that it works
Section titled “Checking that it works”A connected card shows its status next to the provider’s name:
| Status | Meaning |
|---|---|
| Connected | The connection works. |
| Finish setup | Faylee is connected but still needs its settings, such as which project to use. |
| Not working | The last check failed. The provider’s reason is shown on the card. |
| Disconnected | The provider refused to renew Faylee’s access, so Faylee stopped using the connection. |
Faylee checks every connection every six hours, so a revoked token or a deleted project is noticed before someone’s issue fails to file. The first time a working connection starts failing, the workspace’s admins get an email. When the provider refuses to renew Faylee’s access, the connection is marked disconnected and the admins get an email too.
The card’s buttons help you fix it:
- Test checks the connection now.
- Reconnect, on a one-click connection that is not working or disconnected, runs the sign-in again.
- Edit changes the settings, or the keys of a connection made with keys.
Rejected webhooks
Section titled “Rejected webhooks”Faylee checks the signature on every webhook a provider sends and turns away any it can’t verify. When it turns one away, the card shows when and why, for example:
A webhook was turned away 2 hours ago. The X-Hub-Signature-256 did not match the signing secret.This usually means the secret in the provider doesn’t match the one Faylee expects. Copy the signing secret from the card into the provider’s webhook settings again.
Disconnecting
Section titled “Disconnecting”Disconnect on a card asks you to confirm. Faylee then removes the webhook it added at the provider, gives back its access where the provider allows it, and deletes the credentials. Issues already created stay linked from their recordings.
Connecting and disconnecting are recorded in the workspace’s audit log.