Skip to main content

CreateWebhookRequest

eventTypesstring[]required

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"]
urlurirequired

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
sslVerificationDisabledbooleanrequired

If true, SSL verification is enabled for the webhook

statusstringrequired

Webhook status

  • Active
  • Disabled

Possible values: non-empty

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