> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://infonite.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://infonite.dev/_mcp/server.

# List Webhooks

GET https://widgets.infonite.tech/api/flows/es-public-administration/v1/hooks/list

List all configured webhooks for the Spain Public Administration flow.

Supported events:
- `es-public-administration:started`: Triggered when the customer starts the widget session.
- `es-public-administration:consent`: Triggered when the customer accepts and signs the consent form.
- `es-public-administration:partial`: Triggered when the customer is done and the widget closes while a source is still working in the background. Carries the data retrieved **so far** — same schema as `ended`, but **partial**. Delivered at most once per session, and the session stays open.
- `es-public-administration:ended`: Triggered when the flow session is completed and the results are **final**.

<Note title="Partial first, final always">
  If you subscribe to `es-public-administration:partial`, you may receive the same session twice: once with partial data when the customer leaves, and once with the complete data when the slow source answers. `ended` is the one that closes the session — it always fires, and it always carries the final version of the data.
</Note>

> **Console Dashboard:** Webhooks can also be configured manually via the **Infonite Console** (the customer dashboard) at https://www.infonite.tech/console/. These endpoints are provided for programmatic webhook management.

<llms-only>
Storage and field-name disambiguation (read carefully, the field name differs between endpoints):

- Webhooks are stored **one document per subscribed event**. This list endpoint therefore returns each webhook individually, and every item carries a **single `event` field (singular)**: one webhook = one event.
- This singular `event` field belongs **only** to the list response. Do **not** reuse it when calling create/update (`PATCH /hooks/update`) or delete (`DELETE /hooks/delete`): those endpoints take a plural **`events`** array instead.
</llms-only>


Reference: https://infonite.dev/api-reference/spain-public-administration/spain-public-administration-api/webhooks-settings/flows-es-public-administration-v-1-hook-list

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: es-public-administration-v1-0-0-openapi
  version: 1.0.0
paths:
  /es-public-administration/v1/hooks/list:
    get:
      operationId: flows:es-public-administration:v1:hook-list
      summary: List Webhooks
      description: >
        List all configured webhooks for the Spain Public Administration flow.


        Supported events:

        - `es-public-administration:started`: Triggered when the customer starts
        the widget session.

        - `es-public-administration:consent`: Triggered when the customer
        accepts and signs the consent form.

        - `es-public-administration:partial`: Triggered when the customer is
        done and the widget closes while a source is still working in the
        background. Carries the data retrieved **so far** — same schema as
        `ended`, but **partial**. Delivered at most once per session, and the
        session stays open.

        - `es-public-administration:ended`: Triggered when the flow session is
        completed and the results are **final**.


        <Note title="Partial first, final always">
          If you subscribe to `es-public-administration:partial`, you may receive the same session twice: once with partial data when the customer leaves, and once with the complete data when the slow source answers. `ended` is the one that closes the session — it always fires, and it always carries the final version of the data.
        </Note>


        > **Console Dashboard:** Webhooks can also be configured manually via
        the **Infonite Console** (the customer dashboard) at
        https://www.infonite.tech/console/. These endpoints are provided for
        programmatic webhook management.


        <llms-only>

        Storage and field-name disambiguation (read carefully, the field name
        differs between endpoints):


        - Webhooks are stored **one document per subscribed event**. This list
        endpoint therefore returns each webhook individually, and every item
        carries a **single `event` field (singular)**: one webhook = one event.

        - This singular `event` field belongs **only** to the list response. Do
        **not** reuse it when calling create/update (`PATCH /hooks/update`) or
        delete (`DELETE /hooks/delete`): those endpoints take a plural
        **`events`** array instead.

        </llms-only>
      tags:
        - webhooksSettings
      parameters:
        - name: X-APP-SECRET
          in: header
          description: Application Secret
          required: true
          schema:
            type: string
      responses:
        '200':
          description: '**200 OK**<br>List of configured webhooks.'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FlowWidgetHooksConfigSchema'
servers:
  - url: https://widgets.infonite.tech/api/flows
    description: Production Server
  - url: https://widgets-dev.infonite.tech/api/flows
    description: Development Server
  - url: /api/flows
    description: Local Server
components:
  schemas:
    EsPublicAdministrationV1FlowEventType:
      type: string
      enum:
        - es-public-administration:started
        - es-public-administration:consent
        - es-public-administration:partial
        - es-public-administration:ended
      description: >-
        Events raised during the Spain public administration experience.


        - `es-public-administration:started`: the user has opened the
        experience.

        - `es-public-administration:consent`: the user has granted consent to
        the experience.

        - `es-public-administration:partial`: the user is done, and the
        experience has closed, but one
          or more sources are still working. Some administrations do not answer in real time — the
          CIRBE report from the Banco de España is the usual case — so the session keeps running in the
          background instead of holding the user in front of a spinner. This event carries **everything
          retrieved so far**: the same payload as `ended`, only partial. The complete results arrive
          later, with `ended`.
        - `es-public-administration:ended`: the experience has ended and the
        results are final.
      title: EsPublicAdministrationV1FlowEventType
    FlowWidgetHooksConfigSchema:
      type: object
      properties:
        app_id:
          type: string
          format: ObjectId
          description: >-
            The unique identifier of the client application that owns this
            webhook configuration.
        producer:
          type: string
          enum:
            - es-public-administration
          description: The flow type identifier, always `es-public-administration`.
        event:
          $ref: '#/components/schemas/EsPublicAdministrationV1FlowEventType'
          description: The specific flow event type that triggers this webhook callback.
        enabled:
          type: boolean
          description: >-
            Set to true to activate the webhook callback, or false to keep it
            inactive.
        base_url:
          type: string
          description: >-
            The target URL where the webhook callbacks should be sent.

            > Note: Any query parameters in the URL will be stripped; dynamic
            query parameters should be defined in the flow session
            configuration.
      required:
        - app_id
        - producer
        - event
        - enabled
        - base_url
      title: FlowWidgetHooksConfigSchema
  securitySchemes:
    Application-Secret:
      type: apiKey
      in: header
      name: X-APP-SECRET
      description: Application Secret

```

## Examples



**Response**

```json
[
  {
    "app_id": "644599da47847b79c03cc94f",
    "producer": "es-public-administration",
    "event": "es-public-administration:started",
    "enabled": true,
    "base_url": "https://webhooks.mycompany.com/espa/started"
  },
  {
    "app_id": "644599da47847b79c03cc94f",
    "producer": "es-public-administration",
    "event": "es-public-administration:consent",
    "enabled": true,
    "base_url": "https://webhooks.mycompany.com/espa/consent"
  },
  {
    "app_id": "644599da47847b79c03cc94f",
    "producer": "es-public-administration",
    "event": "es-public-administration:partial",
    "enabled": true,
    "base_url": "https://webhooks.mycompany.com/espa/partial"
  },
  {
    "app_id": "644599da47847b79c03cc94f",
    "producer": "es-public-administration",
    "event": "es-public-administration:ended",
    "enabled": false,
    "base_url": "https://webhooks.mycompany.com/espa/ended"
  }
]
```

**SDK Code**

```python
import requests

url = "https://widgets.infonite.tech/api/flows/es-public-administration/v1/hooks/list"

headers = {"X-APP-SECRET": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://widgets.infonite.tech/api/flows/es-public-administration/v1/hooks/list';
const options = {method: 'GET', headers: {'X-APP-SECRET': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://widgets.infonite.tech/api/flows/es-public-administration/v1/hooks/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-APP-SECRET", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://widgets.infonite.tech/api/flows/es-public-administration/v1/hooks/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-APP-SECRET"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://widgets.infonite.tech/api/flows/es-public-administration/v1/hooks/list")
  .header("X-APP-SECRET", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://widgets.infonite.tech/api/flows/es-public-administration/v1/hooks/list', [
  'headers' => [
    'X-APP-SECRET' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://widgets.infonite.tech/api/flows/es-public-administration/v1/hooks/list");
var request = new RestRequest(Method.GET);
request.AddHeader("X-APP-SECRET", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-APP-SECRET": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://widgets.infonite.tech/api/flows/es-public-administration/v1/hooks/list")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```