Skip to content

Commit

Permalink
Merge branch 'current' into fix-version-orders
Browse files Browse the repository at this point in the history
  • Loading branch information
JKarlavige authored Sep 17, 2024
2 parents 9651162 + d9e7e72 commit 24e4930
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 3 deletions.
16 changes: 15 additions & 1 deletion 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 supports [Authorization headers](#troubleshooting).

## 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 @@ -551,3 +558,10 @@ DELETE https://{your access URL}/api/v3/accounts/{account_id}/webhooks/subscript
- [dbt Cloud CI](/docs/deploy/continuous-integration)
- [Use dbt Cloud's webhooks with other SaaS apps](https://docs.getdbt.com/guides?tags=Webhooks)

## Troubleshooting

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>
```
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Because the values of `flags` can differ across invocations, we strongly advise
| [print](/reference/global-configs/print-output#suppress-print-messages-in-stdout) | boolean | True | ❌ | `DBT_PRINT` | `--print` | ❌ |
| [printer_width](/reference/global-configs/print-output#printer-width) | int | 80 | ✅ | `DBT_PRINTER_WIDTH` | `--printer-width` | ❌ |
| [profile](/docs/core/connect-data-platform/connection-profiles#about-profiles) | string | None | ✅ (as top-level key) | `DBT_PROFILE` | `--profile` | ❌ |
| [profiles_dir](/docs/core/connect-data-platform/connection-profiles#about-profiles) | path | None (current dir, then HOME dir) | ❌ | `DBT_PROFILES_DIR` | `--log-path` | ❌ |
| [profiles_dir](/docs/core/connect-data-platform/connection-profiles#about-profiles) | path | None (current dir, then HOME dir) | ❌ | `DBT_PROFILES_DIR` | `--profiles-dir` | ❌ |
| [project_dir](/reference/dbt_project.yml) | path | | ❌ | `DBT_PROJECT_DIR` | `--project-dir` | ❌ |
| [quiet](/reference/global-configs/logs#suppress-non-error-logs-in-output) | boolean | False | ❌ | `DBT_QUIET` | `--quiet` | ✅ |
| [resource-type](/reference/global-configs/resource-type) (v1.8+) | string | None | ❌ | `DBT_RESOURCE_TYPES` <br></br> `DBT_EXCLUDE_RESOURCE_TYPES` | `--resource-type` <br></br> `--exclude-resource-type` | ✅ |
Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/resource-configs/strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ This is a **required configuration**. There is no default value.
</File>


### Use the check_cols strategy
### Use the check strategy

```sql
{% snapshot orders_snapshot_check %}
Expand Down

0 comments on commit 24e4930

Please sign in to comment.