You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -15,7 +15,7 @@ Connectors is a Svix feature that lets you provide your customers with pre-made
15
15
16
16
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.
17
17
18
-

18
+

19
19
20
20
To configure a connector, you need to provide the following details:
21
21
@@ -66,15 +66,15 @@ Your customers will be able to customize the transformation code and the event t
66
66
67
67
After creating at least one connector, your customers will be able to choose it when creating an endpoint.
68
68
69
-

69
+

70
70
71
71
## Connection types
72
72
73
73
### <ConnectorLogoname="slack" /> Slack \{#slack}
74
74
75
75
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.
76
76
77
-

77
+

78
78
79
79
The transformation code should format the webhook payload according to [Slack's Incoming Webhook API](https://api.slack.com/messaging/webhooks#posting_with_webhooks).
80
80
@@ -106,7 +106,7 @@ function handler(webhook) {
106
106
107
107
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.
108
108
109
-

109
+

110
110
111
111
The transformation code should format the webhook payload according to [Discord's Execute Webhook API](https://discord.com/developers/docs/resources/webhook#execute-webhook).
112
112
@@ -144,7 +144,7 @@ The Microsoft Teams integration will show your users instructions on how to get
144
144
145
145
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).
146
146
147
-

147
+

148
148
149
149
Here's an example transformation for a support ticket created event:
150
150
@@ -198,7 +198,7 @@ The integration will request access to the following [OAuth scopes](https://deve
198
198
-`crm.objects.quotes.write`
199
199
-`crm.objects.marketing_events.write`
200
200
201
-

201
+

202
202
203
203
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.
204
204
@@ -462,7 +462,7 @@ function handler(webhook) {
462
462
463
463
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.
464
464
465
-

465
+

466
466
467
467
Since Windmill webhooks support arbitrary payloads, it does not require any custom transformation code.
468
468
@@ -483,6 +483,8 @@ Since Zapier Webhooks support arbitrary payloads, it does not require any custom
483
483
484
484
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.
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
+

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).
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.
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)).
0 commit comments