Webhooks API

Update a webhook

Updates the webhook. You may edit the name, url and the list of subscribed event types.

patch/v2/webhooks/{webhookId}

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

namestring

A name that identifies the webhook.

urlstring

The URL Mollie will send the events to. This URL must be publicly accessible.

testmodeboolean

Whether the entity was created in test mode or live mode. This field does not update the mode of the entity.

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Example request

{
  "name": "Webhook #1",
  "url": "https://mollie.com/",
  "eventTypes": [
    "payment-link.paid"
  ]
}

Response

The webhook object.

Changes

Changed in 6 of the 79 revisions of this API.1839

    • 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 capture.failed enum value to the request property ////

      request-property-enum-value-added

    • added the new capture.failed enum value to the request property //

      request-property-enum-value-added

    • added the new capture.succeeded enum value to the request property ////

      request-property-enum-value-added

    • added the new capture.succeeded enum value to the request property //

      request-property-enum-value-added

    • added the new chargeback.received enum value to the request property ////

      request-property-enum-value-added

    • added the new chargeback.received enum value to the request property //

      request-property-enum-value-added

    • added the new chargeback.reversed enum value to the request property ////

      request-property-enum-value-added

    • added the new chargeback.reversed enum value to the request property //

      request-property-enum-value-added

  • 19c365c4aee424See the full diff
    • 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 new sales-invoice.e-invoice-failed enum value to the request property ////

      request-property-enum-value-added

    • added the new sales-invoice.e-invoice-failed enum value to the request property //

      request-property-enum-value-added

    • added the new sales-invoice.e-invoice-issued enum value to the request property ////

      request-property-enum-value-added

    • added the new sales-invoice.e-invoice-issued enum value to the request property //

      request-property-enum-value-added

    • added the non-success response with the status

      response-non-success-status-added

  • f5e0eb3b7313510See the full diff
    • 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

    • added the new payout.canceled enum value to the request property ////

      request-property-enum-value-added

    • added the new payout.canceled enum value to the request property //

      request-property-enum-value-added

    • added the new payout.completed enum value to the request property ////

      request-property-enum-value-added

    • added the new payout.completed enum value to the request property //

      request-property-enum-value-added

    • added the new payout.failed enum value to the request property ////

      request-property-enum-value-added

    • added the new payout.failed enum value to the request property //

      request-property-enum-value-added

    • added the new payout.initiated enum value to the request property ////

      request-property-enum-value-added

    • added the new payout.initiated enum value to the request property //

      request-property-enum-value-added

    • added the new payout.processing-at-bank enum value to the request property ////

      request-property-enum-value-added

    • added the new payout.processing-at-bank enum value to the request property //

      request-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

  • e5af12275c86714See the full diff
    • 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

    • added the new business-account-transfer.blocked enum value to the request property ////

      request-property-enum-value-added

    • added the new business-account-transfer.blocked enum value to the request property //

      request-property-enum-value-added

    • added the new business-account-transfer.failed enum value to the request property ////

      request-property-enum-value-added

    • added the new business-account-transfer.failed enum value to the request property //

      request-property-enum-value-added

    • added the new business-account-transfer.initiated enum value to the request property ////

      request-property-enum-value-added

    • added the new business-account-transfer.initiated enum value to the request property //

      request-property-enum-value-added

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

      request-property-enum-value-added

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

      request-property-enum-value-added

    • added the new business-account-transfer.processed enum value to the request property ////

      request-property-enum-value-added

    • added the new business-account-transfer.processed enum value to the request property //

      request-property-enum-value-added

    • added the new business-account-transfer.requested enum value to the request property ////

      request-property-enum-value-added

    • added the new business-account-transfer.requested enum value to the request property //

      request-property-enum-value-added

    • added the new business-account-transfer.returned enum value to the request property ////

      request-property-enum-value-added

    • added the new business-account-transfer.returned enum value to the request property //

      request-property-enum-value-added

Of the 79 revisions, 9 have no diff computed.