Skip to content

Commit

Permalink
Update Ingest docs with the latest dashboard features (#188)
Browse files Browse the repository at this point in the history
- Add Slack and Segment as sources
- Move API examples below the dashboard guides. Now that the UI is more
capable, I think it makes sense to put it first, since that use case
will be more common than the API.
- Add UI guides for token rotation. It's not API-only anymore.
  • Loading branch information
svix-lucho authored Jan 21, 2025
1 parent cdea304 commit 774a818
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions docs/receiving/receiving-with-ingest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ webhook providers. Supported values for a `Source`'s `type` include:
- `resend`
- `safebase`
- `sardine`
- `segment`
- `shopify`
- `slack`
- `stripe`
- `stych`
- `svix` (that's us!)
Expand All @@ -45,7 +47,11 @@ Let us know if your webhook provider isn't yet supported so we can add it!

## Create a Source

Creating a `Source` can be done from either the API:
Creating a `Source` from the [Ingest Dashboard]:

![screenshot of the Ingest Dashboard showing the overview tab for a Source named "demo"](../../static/img/ingest/source-edit.png)

or through the API:

```shell
curl https://api.svix.com/ingest/api/v1/source \
Expand All @@ -63,19 +69,14 @@ curl https://api.svix.com/ingest/api/v1/source \
EOF
```

or from the [Ingest Dashboard]:

![screenshot of the Ingest Dashboard showing the overview tab for a Source named "demo"](../../static/img/ingest/source-edit.png)


## Tell your provider where to send webhooks

The Ingest URL is also listed on the [Ingest Dashboard] for each `Source`.

The `IngestSourceOut` response from the API will include an `ingestUrl` which is
the endpoint you give to your provider, telling them where to send their
webhooks.

The Ingest URL is also listed on the [Ingest Dashboard] for each `Source`.

For GitHub, as is used in this example, this is referred to as the
_"Payload URL"_.

Expand All @@ -101,6 +102,10 @@ recover messages.
The last portion of the Ingest URL is a `Token` which can be
invalidated and rotated:

![screenshot of the Ingest Dashboard showing the overview tab for a Source named "demo"](../../static/img/ingest/url-token-rotate.png)

or through the API:

```shell
curl https://api.svix.com/ingest/api/v1/source/src_xxxxx/token/rotate \
-H "Authorization: Bearer $SVIX_TOKEN" \
Expand All @@ -113,10 +118,6 @@ old and new `Token`s are honored by Ingest. During this period it's important
that you reconfigure your provider with the new Ingest URL in order to have a
seamless transition.

:::note
Token rotation for Sources can only be configured via the API.
:::


## Transformations Support

Expand Down
Binary file added static/img/ingest/url-token-rotate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 774a818

Please sign in to comment.