Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add note about webhook limit #6758

Merged
merged 6 commits into from
Jan 10, 2025
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions website/docs/docs/deploy/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,22 @@ You can also check out the free [dbt Fundamentals course](https://learn.getdbt.c

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

Navigate to **Account settings** in dbt Cloud (by clicking your account name from the left side panel), and click **Create New Webhook** in the **Webhooks** section. You can find the appropriate dbt Cloud access URL for your region and plan with [Regions & IP addresses](/docs/cloud/about-cloud/access-regions-ip-addresses).

To configure your new webhook:

- **Name** — Enter a name for your outbound webhook.
- **Description** — Enter a description of the webhook.
- **Events** — Choose the event you want to trigger this webhook. You can subscribe to more than one event.
- **Jobs** — Specify the job(s) you want the webhook to trigger on. Or, you can leave this field empty for the webhook to trigger on all jobs in your account. By default, dbt Cloud configures your webhook at the account level.
- **Endpoint** — Enter your application's endpoint URL, where dbt Cloud can send the event(s) to.

When done, click **Save**. dbt Cloud provides a secret token that you can use to [check for the authenticity of a webhook](#validate-a-webhook). It’s strongly recommended that you perform this check on your server to protect yourself from fake (spoofed) requests.
1. Navigate to **Account settings** in dbt Cloud (by clicking your account name from the left side panel)
2. Go to the **Webhooks** section and click **Create webhook**.
3. You can find the appropriate dbt Cloud access URL for your region and plan with [Regions & IP addresses](/docs/cloud/about-cloud/access-regions-ip-addresses).
Copy link
Contributor

@matthewshaver matthewshaver Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this step needed for this particular workflow?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i dont think so either but it's also there currently. i can maybe move it up?

4. To configure your new webhook:
- **Webhook name** — Enter a name for your outbound webhook.
- **Description** — Enter a description of the webhook.
- **Events** — Choose the event you want to trigger this webhook. You can subscribe to more than one event.
- **Jobs** — Specify the job(s) you want the webhook to trigger on. Or, you can leave this field empty for the webhook to trigger on all jobs in your account. By default, dbt Cloud configures your webhook at the account level.
- **Endpoint** — Enter your application's endpoint URL, where dbt Cloud can send the event(s) to.
5. When done, click **Save**.

dbt Cloud provides a secret token that you can use to [check for the authenticity of a webhook](#validate-a-webhook). It’s strongly recommended that you perform this check on your server to protect yourself from fake (spoofed) requests.

:::info
Note that dbt Cloud automatically deactivates a webhook after 5 consecutive failed attempts to send events to your endpoint.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
:::

### Differences between completed and errored webhook events {#completed-errored-event-difference}
The `job.run.errored` event is a subset of the `job.run.completed` events. If you subscribe to both, you will receive two notifications when your job encounters an error. However, dbt Cloud triggers the two events at different times:
Expand Down
Loading