GetWebhooksResponse

webhooks object[]nullable

Array of webhooks

Array [

idstringrequired

Webhook ID

Possible values: non-empty

Example: 8guvhke4

eventTypesstring[]nullable

Array of event types

• TransactionsImported - transactions have been successfully imported from a payment provider and imported
• TransactionsImportError - an error occurred when importing transactions from a payment provider
• AccountCreated - an account has been created
• AccountError - a problem with the account is detected, i.e. credentials validation error

Example: ["TransactionsImported","AccountCreated","TransactionsImportError","AccountError"]

urlstring<uri>required

Callback URL

When the event occurs, PayData will send a POST request to this URL

Possible values: non-empty

Example: https://example.de/callback_url

headers objectnullable

Headers to be sent with the request to the callback URL

A dictionary of headers. The key is the header name, the value is the header value.

Optional. Can be used to check that the callback request is sent by PayData.

property name*string

sslVerificationDisabledboolean

If true, SSL verification is enabled for the webhook

createdAtstring<date-time>

Webhook creation timestamp

Example: 2024-04-18T08:11:11.111

lastModifiedAtstring<date-time>

Webhook last modification timestamp

Example: 2024-04-18T08:22:22.222

statusstringnullable

Webhook status

• Active
• Disabled

Example: Active

]

GetWebhooksResponse

{
  "webhooks": [
    {
      "id": "8guvhke4",
      "eventTypes": [
        "TransactionsImported",
        "AccountCreated",
        "TransactionsImportError",
        "AccountError"
      ],
      "url": "https://example.de/callback_url",
      "headers": {
        "X-Partner-Secret": "TgwdYF1hgOVb8M5YOvxOukqfjzYOGRZcJiCjQuRGkVIBfjjV1HF5zKTGiY2aPn2cQTGaQOT8"
      },
      "sslVerificationDisabled": true,
      "createdAt": "2024-04-18T08:11:11.111",
      "lastModifiedAt": "2024-04-18T08:22:22.222",
      "status": "Active"
    }
  ]
}