Create or update the events webhook configuration for the current account/environment.
PUT /webhooks/events
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”Request body for creating or updating the events webhook configuration.
object
Destination URL that receives webhook event payloads. Must be a valid http(s) URL.
List of event types that should be forwarded to the webhook URL.
Responses
Section titled “ Responses ”Successful response
Events webhook configuration returned by the API.
object
Storage key in the format accountId:envId (currently accountId:accountId for account-scoped usage).
Destination URL that receives webhook event payloads.
List of subscribed event types for this webhook configuration.
HMAC secret for verifying webhook signatures. Use this with your X-Pingram-Signature verification.
Bad Request - validation errors, invalid input
Standard error response for API errors.
object
Unique tracking ID for the request.
Structured error details for API error responses.
object
Machine-readable error code.
Human-readable error message.
Actionable hint for fixing the error.
Provider that caused the error (e.g. telnyx, ses).
Provider-specific error code.
Unauthorized
Payment Required - usage limits exceeded
Standard error response for API errors.
object
Unique tracking ID for the request.
Structured error details for API error responses.
object
Machine-readable error code.
Human-readable error message.
Actionable hint for fixing the error.
Provider that caused the error (e.g. telnyx, ses).
Provider-specific error code.
Internal Server Error
Bad Gateway - provider error
Standard error response for API errors.
object
Unique tracking ID for the request.
Structured error details for API error responses.
object
Machine-readable error code.
Human-readable error message.
Actionable hint for fixing the error.
Provider that caused the error (e.g. telnyx, ses).
Provider-specific error code.