Skip to content

Commit

Permalink
Update webhooks.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mirnawong1 authored Sep 17, 2024
1 parent 39e32b0 commit 5339fb2
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions website/docs/docs/deploy/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ You can also check out the free [dbt Fundamentals course](https://learn.getdbt.c
- For `write` access to webhooks:
- **Enterprise plan accounts** — Permission sets are the same for both API service tokens and the dbt Cloud UI. You, or the API service token, must have the [Account Admin](/docs/cloud/manage-access/enterprise-permissions#account-admin), [Admin](/docs/cloud/manage-access/enterprise-permissions#admin), or [Developer](/docs/cloud/manage-access/enterprise-permissions#developer) permission set.
- **Team plan accounts** — For the dbt Cloud UI, you need to have a [Developer license](/docs/cloud/manage-access/self-service-permissions). For API service tokens, you must assign the service token to have the [Account Admin or Member](/docs/dbt-cloud-apis/service-tokens#team-plans-using-service-account-tokens) permission set.
- You have a multi-tenant or an AWS single-tenant deployment model in dbt Cloud. For more information, refer to [Tenancy](/docs/cloud/about-cloud/tenancy).
- You have a multi-tenant or an AWS single-tenant deployment model in dbt Cloud. For more information, refer to [Tenancy](/docs/cloud/about-cloud/tenancy).
- Your destination system must support [Authorization headers](#troubleshooting) for the webhook to work correctly.

## Create a webhook subscription {#create-a-webhook-subscription}

Expand Down Expand Up @@ -72,6 +73,12 @@ return signature == auth_header

```

Note that the destination system must support [Authorization headers](#troubleshooting) for the webhook to work correctly. You can test your endpoint's support by sending a request with curl and an Authorization header, like this:

```shell
curl -H 'Authorization: 123' -X POST https://<your-webhook-endpoint>
```

## Inspect HTTP requests
When working with webhooks, it’s good practice to use tools like [RequestBin](https://requestbin.com/) and [Requestly](https://requestly.io/). These tools allow you to inspect your HTML requests, response payloads, and response headers so you can debug and test webhooks before incorporating them into your systems.

Expand Down Expand Up @@ -553,7 +560,7 @@ DELETE https://{your access URL}/api/v3/accounts/{account_id}/webhooks/subscript

## Troubleshooting

* If your destination system is not correctly receiving dbt Cloud webhooks - check that the system allows Authorization headers. dbt Cloud webhooks necessarily send an Authorization header and if your endpoint does not support receiving Authorization headers, then it may be incompatible with dbt Cloud webhooks. Some services like Azure Logic Apps / Power Automate may not accept Authorization headers and therefore will not work with dbt Cloud webhooks. You can test if your destination endpoint supports Authorization headers by sending a request using curl with an Authorization header - for example:
If your destination system isn't receiving dbt Cloud webhooks, ensure it allows Authorization headers. dbt Cloud webhooks send an Authorization header, and if your endpoint doesn't support this, it may be incompatible. Services like Azure Logic Apps and Power Automate may not accept Authorization headers, so they won't work with dbt Cloud webhooks. You can test your endpoint's support by sending a request with curl and an Authorization header, like this:

```shell
curl -H 'Authorization: 123' -X POST https://<your-webhook-endpoint>
Expand Down

0 comments on commit 5339fb2

Please sign in to comment.