List Webhooks
GET/v1/webhook
Returns the tenant-event webhooks (EMAIL_EVENT, DOMAIN_VERIFICATION) registered for the authenticated tenant/account. IMAP webhooks are not included; view those via the IMAP/OAuth config endpoints.
Responses
- 200
- 500
List of registered webhooks
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
success boolean
webhooks
object[]
active boolean
created_at string
event string
headers_present string[]
method string
options
object
property name* any
updated_at string
url string
webhook_id string
{
"success": true,
"webhooks": [
{
"active": true,
"created_at": "string",
"event": "EMAIL_EVENT",
"headers_present": [
"string"
],
"method": "POST",
"options": {},
"updated_at": "string",
"url": "https://example.com/webhook",
"webhook_id": "email_events_01J..."
}
]
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
details
object
property name* any
error string
success boolean
{
"details": {},
"error": "string",
"success": false
}
Loading...