---
title: "Create a signed webhook endpoint"
method: POST
path: "/webhooks"
tags: ["Webhooks", "Human only"]
---

# Create a signed webhook endpoint

`POST /webhooks`

## Request

- Base URL: `https://gtmswag.com/api/v1`
- URL: `https://gtmswag.com/api/v1/webhooks`
- Auth: API key in cookie `gtm_session`

Human only: A signed-in owner or admin does this in the browser at gtmswag.com. API keys and OAuth connections receive 403 HUMAN_APPROVAL_REQUIRED with a `url` to hand to that person. The URL must be public HTTPS on port 443. The response carries the signing `secret` once. Events created before the endpoint are not sent.

## Request body

- object
  - `url` string, required: Public HTTPS destination for signed tracking events.
  - `events` string[], required: Event types for this webhook, or all.

## Response `201`

Success: `{"data": WebhookWithSecret}`.

- WebhookWithSecretResponse: The success body: `{"data": WebhookWithSecret}`.
  - `data` WebhookWithSecret, required: A new webhook endpoint with its signing `secret`, shown only once.
    - `id` string, required
    - `url` string, required
    - `events` string[], required
    - `secret` string, required

## Other responses

- `400`: Bad request: `VALIDATION_ERROR`, `INVALID_REQUEST`, `INVALID_JSON`. Each example says when.
- `401`: Not authenticated: `AUTH_REQUIRED`. no credentials, or an OAuth token on a route that only takes workspace keys; the key is malformed, unknown or revoked.
- `403`: Forbidden: `HUMAN_APPROVAL_REQUIRED`, `DEMO_LIMITED`, `TEAM_MANAGER_REQUIRED`. Each example says when.
- `413`: Request too large: `INVALID_REQUEST`. the body exceeds 1 MiB.
- `415`: Unsupported media type: `INVALID_REQUEST`. a write with a body that is not `Content-Type: application/json` (a key request with no body needs no Content-Type).
- `429`: Too many requests: `RATE_LIMIT`. more than 240 requests in the current minute for this workspace (REST and MCP share the limit); wait `retryAfterMs`.
- `503`: Unavailable: `WEBHOOK_UNAVAILABLE`. Each example says when.
- `default`: Any other refusal or failure, such as 403 CSRF (a cross-origin `Origin` header), 403 HTTPS_REQUIRED or 500 INTERNAL_ERROR, with what to do next.

---

[API](https://skmtc.dev/gtmswag/apis/gtm-swag-api.md) · [All operations](https://skmtc.dev/gtmswag/apis/gtm-swag-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gtmswag/apis/gtm-swag-api/revisions/9ff86fa99afe?raw)