Skip to main content

WebhookSubscriptionResource

idstring<uuid>
webhook_urlstring
delivery_methodstring
subscribed_event_typesstring[]
auth_typestring

The authentication mechanism configured for this subscription.

Possible values: [HMAC, BASIC]

Example: BASIC
basic_auth_client_idstring

Client ID used for HTTP Basic authentication. Present only when auth_type is BASIC. The client secret is never exposed.

Example: red-de-oro-client
statusstring
max_retry_attemptsinteger<int32>
retry_backoff_secondsinteger<int32>
consecutive_failuresinteger<int32>
circuit_breaker_thresholdinteger<int32>
circuit_breaker_reset_after_secondsinteger<int32>
last_failure_atstring<date-time>
total_events_sentinteger<int32>
total_events_failedinteger<int32>
last_successful_delivery_atstring<date-time>
custom_header_namesstring[]
connection_timeout_msinteger<int32>
read_timeout_msinteger<int32>
descriptionstring
metadata object
property name*object
created_atstring<date-time>
created_bystring
updated_atstring<date-time>
updated_bystring