Skip to main content
Version: Latest

ListWebhooksOutput

data object[]required
  • Array [
  • iduuidrequired
    applicationIduuidrequired
    activebooleanrequired
    eventTypeEventTyperequired

    Possible values: [Message, MessageStatus]

    endpointstringrequired
    labelstringrequired

    Possible values: <= 50 characters

    numberOfErrorsintegerrequired
    authenticationProtocolAuthenticationProtocolrequired

    Possible values: [NoAuthentication, Oauth20, PasswordAuthentication, AWSSignatureV4, JWT, JWTExchange]

    scopestringnullable
    requiresSignaturebooleanrequired
    secretHintstringnullable

    Last six characters of the signing secret when signature verification is enabled

    secretstringnullable

    Full signing secret returned only when enabling signature or immediately after create or redefine

    isVerifiedbooleanrequired
    verifiedAtdate-timenullable
    createdDatedate-timerequired
    lastModifiedDatedate-timerequired
  • ]
  • pagination objectrequired
    offsetintegerrequired
    limitintegerrequired
    totalintegerrequired
    totalPagesintegerrequired
    ListWebhooksOutput
    {
    "data": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "active": true,
    "eventType": "Message",
    "endpoint": "string",
    "label": "string",
    "numberOfErrors": 0,
    "authenticationProtocol": "NoAuthentication",
    "scope": "string",
    "requiresSignature": true,
    "secretHint": "string",
    "secret": "string",
    "isVerified": true,
    "verifiedAt": "2024-07-29T15:51:28.071Z",
    "createdDate": "2024-07-29T15:51:28.071Z",
    "lastModifiedDate": "2024-07-29T15:51:28.071Z"
    }
    ],
    "pagination": {
    "offset": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0
    }
    }