webhooks.get

One webhook endpoint

GET/webhooks/{id}

Operation: webhooks.get
MCP tool: webhooks_get

One endpoint of this account, by id. An endpoint belonging to another account is a 404, never a 403.

curl 'https://api.gogoscreen.com/api/v1/webhooks/3f2b0c1a-9d4e-4a61-b8c2-000000000014' \
  -H "Authorization: Bearer $GOGOSCREEN_API_KEY"

A request to this operation.

json

{
  "endpoint": {
    "id": "3f2b0c1a-9d4e-4a61-b8c2-000000000014",
    "url": "https://hooks.example.com/gogoscreen",
    "events": [
      "render.succeeded",
      "render.failed"
    ],
    "description": "Production receiver",
    "status": "active",
    "failureStreak": 0,
    "disabledAt": null,
    "disabledReason": null,
    "lastDeliveryAt": null,
    "createdAt": "2026-09-21T11:17:00.000Z",
    "updatedAt": "2026-09-21T11:17:00.000Z"
  }
}

200 response, captured from a real call. Ids, timestamps and signed URLs are replaced; the shape is untouched.

At a glance

Fact	Detail
Scopes	`webhooks:manage`
Credentials	a signed in dashboard session or an API key.
Rate limit	120 requests a minute per credential, in the `write` class.
Idempotency	Not applicable. This operation changes nothing.
MCP tool	`webhooks_get`
Always sets	`Cache-Control: private, no-store`
Audit	Every call is written to the audit log as `webhook_management`.

Path parameters

Name	Type	Required	Description
id	string	Required	The resource `id`, from a create answer or the matching list.format: uuid

Response

Answers 200. Every answer also carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, and every error body carries a requestId.

200 OK

One webhook endpoint

Name Type Description

endpoint object

11 fields inside endpoint

Name	Type	Description
createdAt	string	format: date-time
description	string \| null
disabledAt	string \| null	format: date-time
disabledReason	string \| null	`owner` when you turned it off, `consecutive_failures` when we did.
events	string[]	The event types this endpoint asked for. Anything not on the list is not sent.
failureStreak	number	Consecutive failed deliveries. Any success resets it; at 20 the endpoint is disabled automatically.
id	string
lastDeliveryAt	string \| null	format: date-time
status	string	one of: active, disabled
updatedAt	string	format: date-time
url	string	Where the signed POST goes. `https` outside development; the address is re-checked before every delivery.

200 OK headers
Header	Meaning
`Cache-Control`	Always `private, no-store`.

Errors

Every refusal is { error: { code, message, details?, requestId } }. Branch on code, never on the sentence. The full catalogue is at Errors.

Code	Status	When it happens	What to do
validation_failed	400	The merged path, query and body did not match the operation's schema. The schemas are strict, so an unknown field is a failure rather than something ignored, and a string carrying half of a character is refused before it can be stored.	Read `details.issues`. Each entry carries a `path`, a `message` and a machine readable `code`. Fix every named field and send the request again; the same body always fails the same way.
unauthorized	401	No credential was presented, or the key is unknown, revoked or expired, or an `X-API-Key` header carried something that is not an API key. `details.reason` says which.	Send `Authorization: Bearer gsk_live_…`. A revoked or expired key never starts working again, so issue a new one in the developer console. Put a dashboard session token in `Authorization`, never in `X-API-Key`.
forbidden_scope	403	The credential does not carry every scope the operation declares, or it is the wrong kind of credential for it. `keys.` and `assistant.` are user only and can never be called by a key.	`details.requiredScopes` and `details.missingScopes` name what is missing. A key's scopes cannot be changed after it is issued, so create a new key with them. When `details.allowedActors` is present, no key can call this operation at all.
not_found	404	No resource of that id belongs to this account. A resource that belongs to somebody else answers 404 as well, never 403.	Check the id. Do not treat this as a permissions problem.
rate_limited	429	The credential's per minute budget, the account's per minute ceiling, or a daily cap was exceeded. `details.scope` is `minute`, `day` or `account`, or `global` when the product's own daily cap on voice previews is spent.	Wait the `Retry-After` seconds and retry. `details.limit` and `details.resetAt` say what was hit and when it reopens. The `RateLimit-*` headers on every answer let a client pace itself before it gets here.
internal_error	500	An unhandled failure inside this API. The original message is logged and never answered.	Retry once, then quote `requestId` to support. A 5xx deletes the idempotency claim rather than storing it, so retrying under the same key is safe.