Skip to navigation
API: Getting StartedWebhooks & Notifications

Creating a configuration

A new webhook configuration is created by making an HTTP POST call to <server.url>/api/rest/v1/webhooks. The following parameters are accepted:

KeyExample of ValueNoteRequired
typerequestStatus.updatedSpecifies the type of event that the application will be informed of.Yes
urlhttps://[client.url]An HTTPS URL of the application that shall receive webhook calls.Yes
secretA shared secret up to 150 characters longA symmetric key used to produce authentication signatures.No

Example:

{
    "type": "requestStatus.updated",
    "url": "https://[client-url]",
    "secret": "Your secret"
}

Tip

You can either provide a secret when creating webhooks or you can omit it and allow tg-validatord to provide one for you.

The secret will only be communicated during webhook creation, and it will be passed in plaintext within the creation call. If you omit the shared secret, tg-validatord will use a random base64 string of 45 characters. This string will be used as is without decoding. It will be returned via the API once the creation is successful.

Example response:

// 200 OK
{
    "webhook": {
        "id": "44c085b7-dc60-42f7-98fe-ee776aaf5b24",
        "type": "requestStatus.updated",
        "url": "https://[client-url]",
        "status": "enabled",
        "createdAt": "2024-05-29T12:07:56.558167Z"
    },
    "secret": "erQ/wIuSOacrmwkOPrrcEAb1E5bPc3AJIThbqkFRwmU="
}