{
  "opencollection": "1.0.0",
  "info": {
    "name": "Astrada bank-accounts webhooks API",
    "version": "2024-02-28"
  },
  "items": [
    {
      "info": {
        "name": "webhooks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List webhooks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.astrada.co/webhooks",
            "params": [
              {
                "name": "subaccountId",
                "value": "2fd4d402-b759-479c-87a6-58d85e345356",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "25",
                "type": "query",
                "description": "Maximum number of items to return"
              },
              {
                "name": "cursor",
                "value": "ZXhhbXBsZQ==",
                "type": "query",
                "description": "The cursor to use for pagination. Identifies your place on the list"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://api.astrada.co/auth/realms/{accountId}/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Returns all webhooks configured under the account, optionally filtered by subaccount, including details on the events each webhook is subscribed to.\n\nThis endpoint supports [cursor-based pagination](https://docs.astrada.co/reference/pagination).\n"
        },
        {
          "info": {
            "name": "Create webhook",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.astrada.co/webhooks",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://api.astrada.co/auth/realms/{accountId}/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Registers a new webhook for capturing event notifications."
        },
        {
          "info": {
            "name": "Retrieve webhook",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.astrada.co/webhooks/:webhookId",
            "params": [
              {
                "name": "webhookId",
                "value": "3c750084-a60f-478c-ab91-c53567d11fac",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://api.astrada.co/auth/realms/{accountId}/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Returns detailed information about a specific webhook by its identifier, including its configuration and event subscription details."
        },
        {
          "info": {
            "name": "Update webhook",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.astrada.co/webhooks/:webhookId",
            "params": [
              {
                "name": "webhookId",
                "value": "3c750084-a60f-478c-ab91-c53567d11fac",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://api.astrada.co/auth/realms/{accountId}/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Updates the configuration of an existing webhook, allowing changes to the event subscriptions or notification URL."
        },
        {
          "info": {
            "name": "Delete webhook",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.astrada.co/webhooks/:webhookId",
            "params": [
              {
                "name": "webhookId",
                "value": "3c750084-a60f-478c-ab91-c53567d11fac",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "implicit",
              "authorizationUrl": "https://api.astrada.co/auth/realms/{accountId}/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}"
              }
            }
          },
          "docs": "Remove a configured webhook by its identifier. Results in the resource being deleted and no longer available."
        }
      ]
    }
  ],
  "bundled": true
}