Webhooks API

Get a webhook

Retrieve a single webhook object by its ID.

get/v2/webhooks/{webhookId}

Query parameters

testmodeboolean

You can enable test mode by setting the testmode query parameter to true.

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

Headers

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

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

Response

The webhook object.

Changes

Changed in 6 of the 78 revisions of this API.183

    • added the new capture.failed enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new capture.succeeded enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new chargeback.received enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new chargeback.reversed enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new sales-invoice.e-invoice-failed enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new sales-invoice.e-invoice-issued enum value to the / response property for the response status

      response-property-enum-value-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the new payout.canceled enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new payout.completed enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new payout.failed enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new payout.initiated enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new payout.processing-at-bank enum value to the / response property for the response status

      response-property-enum-value-added

    • the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new business-account-transfer.blocked enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new business-account-transfer.failed enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new business-account-transfer.initiated enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new business-account-transfer.pending-review enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new business-account-transfer.processed enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new business-account-transfer.requested enum value to the / response property for the response status

      response-property-enum-value-added

    • added the new business-account-transfer.returned enum value to the / response property for the response status

      response-property-enum-value-added

Of the 78 revisions, 9 have no diff computed.