> For the complete documentation index, see [llms.txt](https://academy.shade.inc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.shade.inc/developers/automate/webhooks.md).

# Webhooks

Shade sends webhooks through Svix for events such as `asset.uploaded`, `asset.moved`, `preview.completed`, and `transcription.completed`. `GET /workspaces/{workspace_id}/webhook-dashboard-url` opens the dashboard where you add endpoints and replay deliveries.

See [Webhooks](https://academy.shade.inc/developers/webhooks) for event payloads and signature verification.

## Get Svix webhook dashboard URL for workspace

> Generate and return a Svix dashboard URL for the workspace webhooks.\
> User must be an admin, member, or owner of the workspace.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"webhooks","description":"Shade sends webhooks through Svix for events such as `asset.uploaded`,\n`asset.moved`, `preview.completed`, and `transcription.completed`.\n`GET /workspaces/{workspace_id}/webhook-dashboard-url` opens the dashboard\nwhere you add endpoints and replay deliveries.\n\nSee [Webhooks](https://academy.shade.inc/developers/webhooks) for event\npayloads and signature verification."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_id}/webhook-dashboard-url":{"get":{"tags":["webhooks"],"summary":"Get Svix webhook dashboard URL for workspace","description":"Generate and return a Svix dashboard URL for the workspace webhooks.\nUser must be an admin, member, or owner of the workspace.","operationId":"getWebhookDashboardUrl","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Get Svix webhook zapier integration key for workspace

> Generate and return a Svix dashboard URL for the workspace webhooks.\
> User must be an admin, member, or owner of the workspace.

```json
{"openapi":"3.1.0","info":{"title":"Shade API","version":"dev"},"tags":[{"name":"webhooks","description":"Shade sends webhooks through Svix for events such as `asset.uploaded`,\n`asset.moved`, `preview.completed`, and `transcription.completed`.\n`GET /workspaces/{workspace_id}/webhook-dashboard-url` opens the dashboard\nwhere you add endpoints and replay deliveries.\n\nSee [Webhooks](https://academy.shade.inc/developers/webhooks) for event\npayloads and signature verification."}],"servers":[{"url":"https://api.shade.inc","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Shade API key, sent as-is with no `Bearer` prefix. Create one under\n**Settings → Integrate → API keys**.\n"}},"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/workspaces/{workspace_id}/zapier-integration-key":{"get":{"tags":["webhooks"],"summary":"Get Svix webhook zapier integration key for workspace","description":"Generate and return a Svix dashboard URL for the workspace webhooks.\nUser must be an admin, member, or owner of the workspace.","operationId":"getZapierIntegrationKey","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The workspace id"},"description":"ID of the workspace. List yours with `GET /workspaces`."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://academy.shade.inc/developers/automate/webhooks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
