Avoca — Internal

Appearance

--- aside: false outline: false ---

Get many webhook requests​

GET
/clients/{clientId}/webhook-requests

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

clientId*
Type
string
Required
Pattern
"^cl_"

Query Parameters

event
Type
string
status
Type
string
Valid values
"Pending""Completed""Failed"
pageIndex
Type
[ "integer", "null" ]
Minimum
0
Default
0
pageSize
Type
[ "integer", "null" ]
Minimum
0
Maximum
100
Default
25

Responses​

Paged webhook request objects

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string",
  
  
  
"client": "string",
  
  
  
"completedAt": "string",
  
  
  
"event": "string",
  
  
  
"failedAt": "string",
  
  
  
"failedDetails": null,
  
  
  
"payload": null,
  
  
  
"status": "string"
  
  
}
  
],
  
"pageIndex": 0,
  
"pageSize": 0,
  
"totalCount": 0
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI