/webhooks/{id}Read operationGet a webhook
Use this operation to get a webhook. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
webhooks:readPrepare this request
The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.
Path parameters
1idrequiredStable identifier of the resource in the authenticated workspace.
Responses
8200The request to get a webhook succeeded. The response contains the canonical public result and request metadata.application/json
application/jsonCredential-owned v2 webhook. List and get responses are secret-free and carry a strong whk1 revision. Only create may include the reveal-only initial signing secret.
The attributes associated with this webhook.
actionsrequiredThe actions associated with this webhook attributes.
disabledrequiredWhether this resource is disabled for new use.
failCountrequiredNumber of fail records represented by this webhook attributes.
lastStatusrequiredThe last status associated with this webhook attributes.
signingSecretReveal-only initial signing secret returned by a no-store webhook create response.
urlrequiredHTTPS destination without URL credentials or a fragment.
versionrequiredCanonical version value for this webhook attributes.
12revisionrequiredStrong resource revision used for optimistic concurrency control.
idrequiredStable TeamGrid identifier for this resource.
typerequiredCanonical type discriminator for this resource.
Public API representation of meta.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
400The request is invalid.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
401The bearer credential is missing, invalid, expired, or revoked.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
403The credential has insufficient scope.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
404The tenant-scoped resource does not exist.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
429The credential or source exceeded its rate limit.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
502The cell-local application returned an invalid response.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
503A required cell-local dependency is unavailable.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
Thank you. The rating contains no account or customer data.