accountWebhooks

Overview

Get list of active webhooks.

Special Considerations

  • Must make an account before calling this query.

Inputs

None.

Returns

Promise<Webhook[]>

Returns a promise containing an array of Webhooks, where each Webhook is:

Webhook: {
    id: ID!,
    account: Account,
    webhookEndpoint: string!,
    webhookSecret: string!,
    webhookEnvironment: Webhookenvironment!,
    isActive: boolean!,
    createdAt: DateTime!,
    updatedAt: DateTime!,
}

Example

Running this query:

query {
    accountWebhooks {
        id
        webhookEndpoint
        webhookSecret
        isActive
        createdAt
        updatedAt
    }
}

Gives us:

{
"data": {
    "accountWebhooks": [
        {
            "id": "ckbayt7mw001407294a4d0q2y",
            "webhookEndpoint": "https://example-borderless-user.com/notifications"
            "webhookSecret": "12940b96-0b1b-4d90-95c0-f797f9376965",
            "isActive": true,
            "createdAt": "2020-10-09T00:00:00Z",
            "updatedAt": "2020-10-09T00:00:00Z",
        }
    ]
}
}

Common Errors

N/A

← PreviousembedVerificationService →