Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

A managed API key, sent as Authorization: Bearer <key>. A workspace key is prefixed tgcc_; a reseller key is prefixed tgpk_. Keys carry scopes; the scope each operation demands is on the operation as x-required-scope.

Body

An endpoint, minus its secret.

environment is accepted as the environment's id, and validated in the view against the tenant rather than here — a serializer that resolved it would have to be handed the company, and the check has to fail as a 404 rather than a validation error (see WebhookEndpointViewSet).

url
string<uri>
required
Maximum string length: 500
api_version
enum<string>
  • 2026-01-01 - Envelope 2026-01-01
  • legacy - Legacy (bare payload)
Available options:
2026-01-01,
legacy
description
string
Maximum string length: 200
enabled_events
any
environment
string<uuid> | null
status
enum<string>
  • active - Active
  • disabled - Disabled
Available options:
active,
disabled

Response

An endpoint, minus its secret.

environment is accepted as the environment's id, and validated in the view against the tenant rather than here — a serializer that resolved it would have to be handed the company, and the check has to fail as a 404 rather than a validation error (see WebhookEndpointViewSet).

application
string | null
required
read-only
created_at
string<date-time>
required
read-only
environment_name
string | null
required
read-only
id
string<uuid>
required
read-only
secret_hint
string
required
read-only
secret_rotated_at
string<date-time> | null
required
read-only
updated_at
string<date-time>
required
read-only
url
string<uri>
required
Maximum string length: 500
api_version
enum<string>
  • 2026-01-01 - Envelope 2026-01-01
  • legacy - Legacy (bare payload)
Available options:
2026-01-01,
legacy
description
string
Maximum string length: 200
enabled_events
any
environment
string<uuid> | null
status
enum<string>
  • active - Active
  • disabled - Disabled
Available options:
active,
disabled