Skip to main content

PatchWebhookRequest

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

Optional. If not specified, the current value is not changed.

Example: ["TransactionsImported"]
urlurinullable

Callback URL

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

Optional. If not specified, the current value is not changed.

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.

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

Optional. If not specified, the current value is not changed.

If specified, the new headers are merged with the existing headers, i.e. new headers are added, existing headers are updated. To delete a header, use the UpdateWebhook method.

property name*string
statusstringnullable

Webhook status

  • Active
  • Disabled

Optional. If not specified, the current value is not changed.

Example: Disabled
sslVerificationDisabledbooleannullable

If true, SSL verification is enabled for the webhook

Optional. If not specified, the current value is not changed.

PatchWebhookRequest
{
  "eventTypes": [
    "TransactionsImported"
  ],
  "url": "https://example.de/callback_url",
  "headers": {
    "X-Partner-Secret": "TgwdYF1hgOVb8M5YOvxOukqfjzYOGRZcJiCjQuRGkVIBfjjV1HF5zKTGiY2aPn2cQTGaQOT8"
  },
  "status": "Disabled",
  "sslVerificationDisabled": true
}