This event triggers when a consent is revoked.

Event Message

The table below describes the structure of the event.

Field	Description	Values
`event`	The event this webhook relates too.	`open_banking.consent.revoked`
`consent_id`	The consent this event relates too.
`customer_id`	The customer this consent relates too
`provider`	The provider this consent is associated with
`updated_at`	The date time that the event occurred

Examples

{
  "data": {
    "consent_id": "ab32780a-3d60-4d4d-984f-11ea3ef329cd",
    "customer_id": "99e911e9-d084-4790-9911-52fdf482fe95",
    "provider": "Natwest",
    "updated_at": "2023-10-02T14:05:55Z",
    "event": "open_banking.consent.revoked"
  }
}

How And When Is This Event Triggered

This events trigger when an Open Banking consent been revoked.

Result Of A Provider Revoke Request

The diagram below describes how the webhook is trigger when using the Initiate Revoke Consent endpoint.

Result of Delete Customer Request

The diagram below describes how the webhook is trigger when using the Remove Customer endpoint.

Consent Found To Be Revoke During A Refresh

Users can revoked consent using the provider website/app. This will then be discover during a refresh.

In this case, the refresh webhook will have the a result of connection_revoked. However, a customer can have multiple consents with a provider, so this webhook provides granularity.