Skip to content
OperadeDocs

Search documentation

Type to search documentation.

Documentation
Copy page
Open raw Markdown

Get the post-call webhook

Return the workspace post-call webhook configuration and delivery status.

Endpoint

GET/api/v1/workspaces/{workspace_id}/webhooks/post-call

Authentication

Operation classAuthenticationMinimum roleAPI key
dashboard-session-apiDashboard session cookie; mutations also require X-CX-Request: 1.adminNot allowed

Parameters

NameInTypeRequiredDescription
workspace_idpathstringYes—

Request body

This operation has no request body.

Example

cURL
curl --request GET 'https://operade.ai/api/v1/workspaces/ws_demo/webhooks/post-call' \
  --cookie 'cx_session=YOUR_SESSION_COOKIE'

Responses

StatusDescriptionContent
4XXHandled client errorapplication/json: ErrorResponse
200Successful Responseapplication/json: object

4XX application/json response schema

Field pathTypeReferenceFormatNullableRequiredEnumDescription
$objectErrorResponse—NoYes——
errorobjectErrorItem—NoYes——
error.codestring——NoYes——
error.detailsobject——NoNo——
error.messagestring——NoYes——

200 application/json response schema

Field pathTypeReferenceFormatNullableRequiredEnumDescription
$objectPostCallWebhookNotConfigured or PostCallWebhook—NoYes——
configuredboolean——NoYesfalse—
created_atstring—date-timeNoYes——
enabledboolean——NoYes——
last_delivery_atstring or null—date-timeYesYes——
last_errorstring or null——YesYes——
last_statusinteger or null——YesYes——
updated_atstring—date-timeNoYes——
urlstring——NoYes——

Response example

Response body JSON
{
  "configured": false
}

Errors

Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.

StatusCodeDescription
401unauthenticatedAuthentication is missing, invalid, or revoked.
403forbiddenThe authenticated caller does not have access to this operation.
404not_foundThe requested workspace resource was not found.
On this page
  1. Endpoint
  2. Authentication
  3. Parameters
  4. Request body
  5. Example
  6. Responses
  7. 4XX application/json response schema
  8. 200 application/json response schema
  9. Response example
  10. Errors
  11. Related operations