# Webhook Connect Events Lists
source: https://developer.mastercard.com/open-finance-au/documentation/connect/webhooks/webhooks-event-connect/index.md

This page documents the complete list of events that you can retrieve via webhooks from the Open Finance Connect application.

## ping {#ping}

|  Name  |    Connect Support    |                                                                                   Description                                                                                   |
|--------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `ping` | Generate Connect Full | Sent when the Generate Connect URL APIs are called to verify that the webhook URL is accessible. This endpoint must return a 200 series or the Generate Connect URL call fails. |

* JSON

```JSON
{
  "eventType": "ping",
  "payload": {}
}
```

## financialConsentCreated (deprecated) {#financialconsentcreated-deprecated}

Note: This event is deprecated. To track consent lifecycle and content use [Consent Notifications](https://developer.mastercard.com/open-finance-au/documentation/consent/consent-notifications/index.md) instead.

|           Name            |    Connect Support    |                                                           Description                                                            |
|---------------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------|
| `financialConsentCreated` | Generate Connect Full | Sent when the customer consents to sharing data through Open Finance. Only becomes relevant when the customer adds the accounts. |

* JSON

```JSON
{
  "customerId": "1017101354",
  "eventType": "financialConsentCreated",
  "eventId": "1658830298174-f8cc188daccbe833482fe292",
  "payload": {
    "receiptId": "e6062836-65e6-4de6-ad99-c9f6552a36fe",
    "scopes": [
      {
        "featureId": "1",
        "id": "common:customer.detail:read",
        "name": "Detailed Customer Data"
      },
      {
        "featureId": "2",
        "id": "common:customer.detail:read",
        "name": "Detailed Customer Data"
      },
      {
        "featureId": "3",
        "id": "bank:accounts.basic:read",
        "name": "Basic Bank Account Data"
      },
      {
        "featureId": "5",
        "id": "bank:transactions:read",
        "name": "Bank Transaction Data"
      }
    ],
    "accessPeriod": {
      "type": "timeframe",
      "startTime": "2022-07-26T10:11:12.079Z",
      "endTime": "2022-09-24T10:11:12.079Z"
    }
  }
}
```

## added {#added}

|  Name   |    Connect Support    |                                                                                  Description                                                                                  |
|---------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `added` | Generate Connect Full | Sent after the customer selected the accounts on data holder (DH) side and returns to Connect. The accounts are saved in the account's resource associated with the customer. |

* JSON

```JSON
  {
    "customerId": "1017101354",
    "eventType": "added",
    "eventId": "1611877956869-28ebb24c66699bf3c77f04b1",
    "payload": {
      "institutionId": "101732",
      "accounts": [
        {
          "id": "11468417",
          "number": "xxxx-xxxx-xxxx-0101",
          "accountNumberDisplay": "xxxx-xxxx-xxxx-0101",
          "name": "Transaction",
          "balance": 22327.3,
          "type": "transactionAndSavings",
          "status": "active",
          "customerId": "1463546",
          "institutionId": "200003",
          "balanceDate": 1704384285,
          "createdDate": 1704384285,
          "lastUpdatedDate": 1704423887,
          "currency": "AUD",
          "institutionLoginId": 1686094,
          "accountNickname": "Transaction",
          "marketSegment": "personal"
        },
        {
          "id": "11468419",
          "number": "xxxx-xxxx-xxxx-0103",
          "accountNumberDisplay": "xxxx-xxxx-xxxx-0103",
          "name": "creditCard",
          "balance": -1952.71,
          "type": "creditCard",
          "status": "active",
          "customerId": "1463546",
          "institutionId": "200003",
          "balanceDate": 1704384285,
          "createdDate": 1704384285,
          "lastUpdatedDate": 1704423887,
          "currency": "AUD",
          "institutionLoginId": 1686094,
          "accountNickname": "creditCard",
          "marketSegment": "personal"
        }
      ],
      "oauth": true,
      "receiptId": "7a24d242-4011-4be2-af7d-004bd4dd4be4"
    },
    "webhookData": {}
}
```

## adding {#adding}

|   Name   |    Connect Support    |                                                 Description                                                 |
|----------|-----------------------|-------------------------------------------------------------------------------------------------------------|
| `adding` | Generate Connect Full | Sent when a customer is redirected to a Financial Institution to log in and select which accounts to share. |

* JSON

```JSON
{
  "customerId": "1463546",
  "eventType": "adding",
  "eventId": "1704384256449-196c11028016c7976922ff2a",
  "payload": {
    "institutionId": "200003",
    "oauth": true
  }
}
```

## done {#done}

|  Name  |    Connect Support    |                                             Description                                             |
|--------|-----------------------|-----------------------------------------------------------------------------------------------------|
| `done` | Generate Connect Full | The **done** event is sent after the customer clicks **Submit** at the end of a Connect experience. |

* JSON

```JSON
{
  "customerId": "1463546",
  "eventType": "done",
  "eventId": "1704384297827-320fa36f67c173fa77be15d8",
  "payload": {}
}
```

## institutionNotFound {#institutionnotfound}

|         Name          |    Connect Support    |                                                           Description                                                           |
|-----------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------|
| `institutionNotFound` | Generate Connect Full | Sent when the user searches for an institution that is not on our list. Connect provides the description for the `query` field. |

* JSON

```JSON
{
  "customerId": "29272504",
  "eventType": "institutionNotFound",
  "eventId": "1564677197519-4f47b664bd855275389e76c6",
  "payload": {
    "query": "not a real institution"
  }
}
```

## institutionSupported {#institutionsupported}

|          Name          |    Connect Support    |                              Description                              |
|------------------------|-----------------------|-----------------------------------------------------------------------|
| `institutionSupported` | Generate Connect Full | Sent when a user selects a Financial Institution from a search query. |

* JSON

```JSON
{
  "customerId": "1463546",
  "eventType": "institutionSupported",
  "eventId": "1704384247615-084d6eac431f80f4083b510d",
  "payload": {
    "institutionId": "200003"
  }
}
```

## processing {#processing}

|     Name     |    Connect Support    |                                                                                               Description                                                                                               |
|--------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `processing` | Generate Connect Full | * Sent after the user selects their accounts from an OAuth connection, and then gets redirected back to Connect. * Sent when a request to generate a report is in the process of generating the report. |

* JSON

```JSON
{
  "customerId": "1463546",
  "eventType": "processing",
  "eventId": "1704384284684-349e4c801ba84fb76b96c091",
  "payload": {
    "institutionId": "200003"
  }
}
```

## started {#started}

|   Name    |    Connect Support    |                                    Description                                     |
|-----------|-----------------------|------------------------------------------------------------------------------------|
| `started` | Generate Connect Full | Sent when the Connect application is loaded and the landing web page is displayed. |

* JSON

```JSON
{
  "customerId": "1463546",
  "eventType": "started",
  "eventId": "1704384242127-71865a94bc331af02d9cd264",
  "payload": {}
}
```

## unableToConnect {#unabletoconnect}

|       Name        |    Connect Support    |                                                                                Description                                                                                 |
|-------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `unableToConnect` | Generate Connect Full | Sent when a Financial Institution is unavailable (unknown reasons) and a connection isn't possible. **Error codes**: 102, 500, 900, 903, 904, 901, 910, 915, 916, and 920. |

* JSON

```JSON
{
  "customerId": "29272504",
  "consumerId": "41d42ef0faef200e370208ad179a44cd",
  "eventType": "unableToConnect",
  "eventId": "1543535415162-6d06cbeed93533d612b4e255",
  "payload": {
    "institutionId": "15880",
    "code": 500
  }
}
```

