Skip to content

Commit 4c12676

Browse files
authored
1 parent 5691c38 commit 4c12676

File tree

7 files changed

+49
-10
lines changed

7 files changed

+49
-10
lines changed
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ hide_title: true
44
---
55

66
import ConnectorLogo from "@site/src/components/ConnectorLogo";
7-
import RAW from '!!raw-loader!@site/docs/connectors.mdx';
7+
import RAW from '!!raw-loader!@site/docs/connectors/connectors.mdx';
88
import HeaderWithCopyButton from '@site/src/components/HeaderWithCopyButton';
99

1010
<HeaderWithCopyButton title="Connectors Endpoints" sourceMarkdown={RAW} />
@@ -15,7 +15,7 @@ Connectors is a Svix feature that lets you provide your customers with pre-made
1515

1616
Connectors are enabled when [enabling transformations](/transformations#enabling-transformations). After enabling Transformations, you will see a new dashboard section where you will be able to create new connectors.
1717

18-
![Connectors list](./img/connectors-list.png)
18+
![Connectors list](../img/connectors-list.png)
1919

2020
To configure a connector, you need to provide the following details:
2121

@@ -66,15 +66,15 @@ Your customers will be able to customize the transformation code and the event t
6666

6767
After creating at least one connector, your customers will be able to choose it when creating an endpoint.
6868

69-
![Adding an Endpoint using a Connector](./img/connectors-endpoint.png)
69+
![Adding an Endpoint using a Connector](../img/connectors-endpoint.png)
7070

7171
## Connection types
7272

7373
### <ConnectorLogo name="slack" /> Slack \{#slack}
7474

7575
The Slack built-in integration lets you send messages to Slack channels via webhooks. It shows a 'Connect to Slack' button that lets your users get a Slack incoming webhook URL using OAuth in a few clicks, without leaving your site.
7676

77-
![Connect to Slack](img/connectors/connect-to-slack.png)
77+
![Connect to Slack](../img/connectors/connect-to-slack.png)
7878

7979
The transformation code should format the webhook payload according to [Slack's Incoming Webhook API](https://api.slack.com/messaging/webhooks#posting_with_webhooks).
8080

@@ -106,7 +106,7 @@ function handler(webhook) {
106106

107107
The Discord built-in integration lets you send messages to Discord channels via webhooks. It shows a 'Connect to Discord' button that lets your users get a Discord incoming webhook URL using OAuth in a few clicks, without leaving your site.
108108

109-
![Connect to Discord](img/connectors/connect-to-discord.png)
109+
![Connect to Discord](../img/connectors/connect-to-discord.png)
110110

111111
The transformation code should format the webhook payload according to [Discord's Execute Webhook API](https://discord.com/developers/docs/resources/webhook#execute-webhook).
112112

@@ -144,7 +144,7 @@ The Microsoft Teams integration will show your users instructions on how to get
144144

145145
The transformation code should format the webhook payload according to [Microsoft Teams' Incoming Webhook API](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using?#send-adaptive-cards-using-an-incoming-webhook).
146146

147-
![Connect to Microsoft Teams](img/connectors/connect-to-teams.png)
147+
![Connect to Microsoft Teams](../img/connectors/connect-to-teams.png)
148148

149149
Here's an example transformation for a support ticket created event:
150150

@@ -198,7 +198,7 @@ The integration will request access to the following [OAuth scopes](https://deve
198198
- `crm.objects.quotes.write`
199199
- `crm.objects.marketing_events.write`
200200

201-
![Connect to Hubspot](img/connectors/connect-to-hubspot.png)
201+
![Connect to Hubspot](../img/connectors/connect-to-hubspot.png)
202202

203203
The transformation code should set the webhook URL to the Hubspot API endpoint (depending on the object) and format the payload appropriately to create the object in Hubspot.
204204

@@ -462,7 +462,7 @@ function handler(webhook) {
462462

463463
The Windmill connector lets your users get a [Windmill](https://windmill.dev) webhook URL in a few clicks from the App Portal. It supports [Windmill Cloud](https://app.windmill.dev) as well as self-hosted Windmill instances.
464464

465-
![Connect to Windmill](img/connectors/connect-to-windmill.png)
465+
![Connect to Windmill](../img/connectors/connect-to-windmill.png)
466466

467467
Since Windmill webhooks support arbitrary payloads, it does not require any custom transformation code.
468468

@@ -483,6 +483,8 @@ Since Zapier Webhooks support arbitrary payloads, it does not require any custom
483483

484484
In case you don't find a built-in integration for the service you want to connect to, you can create a custom integration. You can provide your own integration name and icon, and write instructions for your users on how to use it.
485485

486-
![Custom Integration](./img/connectors/custom-integration.png)
486+
[Learn more about Custom Connectors](/connectors/custom-connector)
487+
488+
![Custom Integration](../img/connectors/custom-integration.png)
487489

488490
If you have a request for a built-in integration not listed above, [contact us](https://www.svix.com/contact/).
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Custom Connector
3+
---
4+
5+
import ConnectorLogo from "@site/src/components/ConnectorLogo";
6+
7+
If you don't find a built-in integration for the service you want to connect to, you can create a Custom Connector.
8+
9+
![Custom Connector in the App Portal](../img/connectors/custom-connector-dropdown.png)
10+
11+
### Configuration
12+
13+
You can provide your own integration name and icon, and write instructions for your users on how to use it (in addition to the [default transformation code](/connectors/#how-to-use-connectors) like in any other connector).
14+
15+
![Custom Connector](../img/connectors/custom-connector-form.png)
16+
17+
You can also (optionally) configure a default endpoint URL and a default authentication method for custom connectors. This will prefill certain fields in the app portal for your customers, to make it easier for them to use the connector.
18+
19+
![Custom Connector Authentication Configuration](../img/connectors/custom-connector-form-auth.png)
20+
21+
The supported authentication methods are `HttpBasic` and `HttpBearer`.
22+
23+
When using `HttpBasic`, the App Portal will display a `username` and `password` input field, and add the `Authorization: Basic base64(<username>:<password>)` header to the endpoint (see [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617)) .
24+
25+
When using `HttpBearer`, the App Portal will display a `token` input field, and add the `Authorization: Bearer <token>` header to the endpoint (see [RFC 6750](https://datatracker.ietf.org/doc/html/rfc6750)).
26+
27+
![Custom Connector Authentication](../img/connectors/custom-connector-auth.png)
93.2 KB
Loading
75.1 KB
Loading
90.7 KB
Loading
93 KB
Loading

sidebars.js

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,17 @@ module.exports = {
1313
"idempotency",
1414
"rate-limit",
1515
"transformations",
16-
"connectors",
16+
{
17+
type: 'category',
18+
label: 'Connector Endpoints',
19+
link: {
20+
type: 'doc',
21+
id: 'connectors/connectors',
22+
},
23+
items: [
24+
"connectors/custom-connector",
25+
]
26+
},
1727
"channels",
1828
{
1929
type: 'category',

0 commit comments

Comments
 (0)