Webhooks API

Sends a test event to the webhook to verify the endpoint is working as expected.

post/v2/webhooks/{webhookId}/ping

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/webhooks/{webhookId}/ping
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: webhooks.write

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Request body

testmodeboolean

You can enable test mode by setting testmode to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

Accepted.

Changes

    • info

      added the non-success response with the status

    • info

      the endpoint scheme security advancedAccessToken was added to the API

    • info

      the endpoint scheme security organizationAccessToken was removed from the API