WebhookConfigResp

  • createdAt
    Type: stringFormat: date-time

    When the webhook was created

  • description
    Type: string

    Description of this webhook configuration

  • eventTypes
    Type: array string[] · WebhookEventType[]enum

    Event types this webhook is subscribed to

    values
    • workflow.started
    • workflow.failed
    • workflow.completed
    • workflow.declined
    • workflow.voided
    • Type: string · WebhookEventTypeenum

      Type of webhook event

      values
      • workflow.started
      • workflow.failed
      • workflow.completed
      • workflow.declined
      • workflow.voided
  • id
    Type: string

    Unique identifier for the webhook configuration

  • isActive
    Type: boolean

    Whether the webhook is currently active

  • organizationId
    Type: string

    Organization this webhook belongs to

  • retryConfig
    Type: object · WebhookRetryConfig
    • backoffStrategy
      Type: stringenum

      Strategy for calculating retry backoff

      values
      • exponential
      • linear
      • constant
    • maxAttempts
      Type: integer

      Maximum number of delivery attempts

    • maxBackoff
      Type: integer

      Maximum backoff time in seconds

    • maxRetryDuration
      Type: integer

      Maximum time in seconds to retry delivery

    • minBackoff
      Type: integer

      Minimum backoff time in seconds

  • updatedAt
    Type: stringFormat: date-time

    When the webhook was last updated

  • url
    Type: stringFormat: uri

    URL receiving webhook events