---
title: "Create a webhook"
method: POST
path: "/v1/webhooks"
tags: ["Activity"]
---

# Create a webhook

`POST /v1/webhooks`

## Request

- Base URL: `https://api.spacefast.com`
- URL: `https://api.spacefast.com/v1/webhooks`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://api.spacefast.com/v1/auth/oauth2/authorize`, token URL `https://api.spacefast.com/v1/auth/oauth2/token`; client credentials, token URL `https://api.spacefast.com/v1/auth/oauth2/token`, scopes: `spaces:write`)

Creates a webhook delivering the selected activity events to a public HTTPS endpoint. The signing secret is returned only in this response.

## Request body

- object
  - `teamId` string
  - `url` string, uri, required
  - `events` string[]

## Response `201`

Response for status 201

- object
  - `$schema` string, uri: Canonical JSON Schema URL for this response body. The server also sends it in the `Link: rel="describedby"` response header.
  - `data` object, required
    - `id` string, required
    - `tenantId` string, required
    - `mode` 'live' | 'test', required: `test` when the owning tenant is a linked test tenant, `live` otherwise.
    - `principal` object, nullable, required
      - `tenantId` string, required
      - `principalType` 'team' | 'external', required
      - `principalId` string, required
    - `url` string, uri, required
    - `events` string[], required
    - `status` 'active' | 'disabled' | 'failing' | 'deleted', required
    - `secret` string
    - `secretPreview` string, required
    - `previousSecretExpiresAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `default`: Problem details (RFC 9457). Any 4xx/5xx response is one `application/problem+json` document.

---

[API](https://skmtc.dev/spacefast/apis/spacefast-api.md) · [All operations](https://skmtc.dev/spacefast/apis/spacefast-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spacefast/apis/spacefast-api/revisions/bd165bc7c983?raw)