{
  "opencollection": "1.0.0",
  "info": {
    "name": "Get on Board Applications Webhooks API",
    "version": "0.1.0"
  },
  "items": [
    {
      "info": {
        "name": "Webhooks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List webhook endpoints",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.getonbrd.com/api/v0/webhook_endpoints",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer YOUR_JWT_TOKEN"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "List webhook endpoints"
        },
        {
          "info": {
            "name": "Create a webhook endpoint",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.getonbrd.com/api/v0/webhook_endpoints",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer YOUR_JWT_TOKEN"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "endpoint",
                  "value": ""
                },
                {
                  "name": "events",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Webhook setup flow: list valid events with `GET /api/v0/webhook_events`, create an endpoint with an HTTPS `endpoint` URL and selected `events`, then use `GET /api/v0/webhook_endpoints` to confirm the saved subscription."
        },
        {
          "info": {
            "name": "Retrieve a webhook endpoint",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.getonbrd.com/api/v0/webhook_endpoints/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer YOUR_JWT_TOKEN"
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "08a3ea6669208832909e2022a073ceb9",
                "type": "path",
                "description": "Webhook endpoint slug from `GET /api/v0/webhook_endpoints`."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieve a webhook endpoint"
        },
        {
          "info": {
            "name": "Update a webhook endpoint",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://www.getonbrd.com/api/v0/webhook_endpoints/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer YOUR_JWT_TOKEN"
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "a3a9bca58d8d4f0c6c7dba65594bde95",
                "type": "path",
                "description": "Webhook endpoint slug from `GET /api/v0/webhook_endpoints`."
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "endpoint",
                  "value": ""
                },
                {
                  "name": "events",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Update a webhook endpoint"
        },
        {
          "info": {
            "name": "Delete a webhook endpoint",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://www.getonbrd.com/api/v0/webhook_endpoints/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer YOUR_JWT_TOKEN"
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "fed4500fec17ca1bf5060625cb11be67",
                "type": "path",
                "description": "Webhook endpoint slug from `GET /api/v0/webhook_endpoints`."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Delete a webhook endpoint"
        },
        {
          "info": {
            "name": "List webhook events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.getonbrd.com/api/v0/webhook_events",
            "headers": [
              {
                "name": "Authorization",
                "value": "Bearer YOUR_JWT_TOKEN"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Call this before creating or updating webhook endpoints. Send only event IDs returned by this endpoint in the `events` array."
        }
      ]
    }
  ],
  "bundled": true
}