Use Cases
- Audit webhook configurations
- Retrieve HMAC keys for signature verification
- List active webhook destinations
- Monitor webhook settings
Response
Returns a Result object containing an array of webhook configurations.Array of webhook objects
Unique identifier for the webhook
ISO 8601 timestamp when the webhook was created
The URL endpoint where webhook events will be sent
Webhook API version (e.g., “2024-10-22”)
JSON string containing webhook configuration including sampleRate, propertyFilters, and includeData settings
HMAC key used to sign webhook requests for verification
Error message if the request failed, null otherwise
Example Request
Example Response
Configuration Object
Theconfig field contains a JSON string with the following properties:
sampleRate: Percentage of requests to send (0-100)propertyFilters: Array of property filters to match specific requestsincludeData: Whether to include full request/response data in webhook payload
