Skip to main content
PUT
Update webhook

Authorizations

Authorization
string
header
required

Authentication Method: HTTP Bearer token.

The runtime requires the literal Bearer prefix — a bare token in the Authorization header is rejected with 401 unauthorized.

Header Format: Authorization: Bearer YOUR_API_KEY

Your API key is a JWT. Live keys operate on live data (livemode: true); test keys operate on isolated test data (livemode: false).

Get your key at: app.gigstack.pro/settings?tab=api

Errors: credential failures are answered by the authentication layer with a raw { "message": … } body, not the standardized envelope — 401 for a missing, malformed or expired token, 403 for a revoked key or a plan without API access. See the Unauthorized and AuthForbidden responses.

Path Parameters

id
string
required

Webhook ID

Example:

"wh_dyS2ZVTj"

Query Parameters

team
string

gigstack Connect: Target team ID for multi-team access.

Requires gigstack Connect enabled on your team and shared billing account.

Also requires the multipleIssuerAccounts feature on your plan. Requests targeting a team other than the one your API key belongs to return 403 without it.

Only API keys can use it: an OAuth access token sent with another team's id is rejected with 403 Team mismatch with OAuth token.

Optional — omit it entirely unless you are acting on another team. It deliberately carries no example value so generated snippets do not emit ?team=undefined; when the parameter is absent, the team is derived from your API key.

Example: ?team=team_xyz789

Body

application/json

Unknown top-level keys are rejected (400 validation_failed / unexpected_key) — body validation runs in strict allowlist mode. team, livemode and owner are reserved and injected by the auth middleware.

url
string<uri>

HTTPS endpoint URL to receive webhook events

Example:

"https://new-domain.com/webhooks/gigstack"

events
enum<string>[]

Array of event types to subscribe to

Minimum array length: 1
Available options:
payment.created,
payment.updated,
payment.succeeded,
payment.canceled,
payment.deleted,
payment.upcoming_due_date,
invoice.created,
invoice.canceled,
invoice.failed,
invoice_batch.completed,
receipt.created,
receipt.updated,
receipt.completed,
receipt.deleted,
customer.created,
customer.updated,
customer.deleted,
service.created,
service.updated,
service.deleted,
sat.invoice.synced
Example:
description
string | null

Optional description of the webhook purpose

Example:

"Updated webhook description"

status
enum<string> | null

Webhook status - active or inactive

Available options:
active,
inactive,
null
Example:

"inactive"

Response

Webhook updated successfully

success
boolean
Example:

true

message
string
Example:

"Webhook updated successfully"

data
object
timestamp
integer<int64>