Webhook events
List Webhook Events
Changed onThis operation retrieves a paginated list of all webhook events.
get/public/v1/webhook-events
Request
- Base URLhttps://api.pandadoc.com
- Auth
- API key in header Authorization
- or OAuth 2Authorization codehttps://app.pandadoc.com/oauth2/authorizeToken URLhttps://api.pandadoc.com/oauth2/access_token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
countinteger required
Specify how many event results to return.
pageinteger required
Specify which page of the dataset to return.
sincestring date-time
Return results where the event creation time is greater than or equal to this value.
tostring date-time
Return results where the event creation time is less than this value.
typeWebhook Event Trigger Enum[]
Returns results by the specified event types.
[ "document_state_changed" ]
http_status_codeWebhook Event Http Status Code Group Enum[]
Returns results with the specified HTTP status codes.
[ 400 ]
errorWebhook Event Error Enum[]
Returns results with the following errors.
[ "TIMEOUT_ERROR" ]
Response
Page of webhook events.
Example response
{
"items": [
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "My Subscription",
"type": "document_state_changed",
"http_status_code": 200,
"error": "TIMEOUT_ERROR",
"delivery_time": "2022-06-20T15:04:59.424730Z"
}
]
}Changes
- warning
added the new
recipient_qes_verifiedenum value to the//response property for the response status - info
added the enum value
recipient_qes_verifiedto the propertyitems/of thequeryrequest parametertype
- warning