Skip to main content
Section ID: DOC-API-MODEL-schema-1fkul0p8vd#overview

RetryConfig

Retry strategy, attempt limit, and interval for failed webhook deliveries.

Meaning and usage​

Section ID: DOC-API-MODEL-schema-1fkul0p8vd#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-1fkul0p8vd#fields

UsageFields and validation
In responsesView fields

In responses​

Section ID: DOC-API-MODEL-schema-1fkul0p8vd#response

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-1fkul0p8vd#field-strategySection ID: DOC-API-MODEL-schema-1fkul0p8vd#response-field-strategystrategystring (RETRY_STRATEGY_LINEAR, RETRY_STRATEGY_EXPONENTIAL) or integer (int32)Optional; explicit presenceWebhook retry strategy selected in the provider configuration.
Section ID: DOC-API-MODEL-schema-1fkul0p8vd#field-retrycountSection ID: DOC-API-MODEL-schema-1fkul0p8vd#response-field-retrycountretryCountstring (int64)OptionalMaximum retry count configured for webhook delivery. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1fkul0p8vd#field-intervalsecondsSection ID: DOC-API-MODEL-schema-1fkul0p8vd#response-field-intervalsecondsintervalSecondsstring (int64)OptionalDelay between webhook delivery retries, in seconds. Pattern: ^-?\d+$.

Values of strategy​

Section ID: DOC-API-MODEL-schema-1fkul0p8vd#response-values-strategy

Backoff strategy applied between webhook delivery attempts.

ValueNo.FormMeaning
RETRY_STRATEGY_LINEAR0CanonicalRetry using the configured linear interval strategy.
RETRY_STRATEGY_EXPONENTIAL1CanonicalIncrease the delay between retries using exponential backoff.

Where used​

Section ID: DOC-API-MODEL-schema-1fkul0p8vd#where-used

ReferenceRelationship
Create a webhook endpointPOST /api/v1/webhooks/create-endpoint
Create a webhook subscriptionPOST /api/v1/webhooks/create-subscription
List webhook subscriptionsPOST /api/v1/webhooks/list-subscriptions
Models containing this value
ModelRelationship
SubscriptionNested in model

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-1fkul0p8vd