Sample - Box Platform API
GET/webhooks/{webhook_id}

Get a webhook

Retrieves a configured webhook by its identifier. Use webhook_id when you need to inspect the webhook's target, notification address, or configured event triggers. The response contains the webhook's configuration and creation details.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
webhook_idstringrequired
The identifier of the webhook to retrieve.

4 status codes
200Returns the webhook object, including its target, creator, creation time, notification address, and configured triggers.
idstringoptional
The unique identifier for this webhook.
typestringoptional
The value will always be `webhook`.
Allowed:webhook
targetobjectoptional
The item that will trigger the webhook.
created_byobjectoptional
created_atstringoptional
A timestamp identifying the time that the webhook was created.
addressstringoptional
The URL that is notified by this webhook.
triggersarray<WebhookTrigger>optional
An array of event names that this webhook is to be triggered for.
403Returned when the application does not have permission to manage webhooks.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
404Returned when the webhook cannot be found.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultReturns a generic error object for an unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 403 is returned when the application does not have permission to manage webhooks. A 404 is returned when no webhook exists with the supplied webhook_id; provide the identifier of an existing webhook.