v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Portfolio Monitoring
Webhook Events

PortfolioItem.updated

Emitted when a portfolio item has been updated.

postWebhookPortfolioItem.updated

Payload

Example payload

{
  "root": {
    "id": "ede786f3-33ae-4894-843d-af2025f1d5b0",
    "search_id": "c623e29e-1f57-11ef-938f-1edb1b067314",
    "user": {
      "first_name": "Austin",
      "last_name": "Taylor",
      "email": "jessicasimpson@example.com"
    },
    "comments": [
      {
        "id": "ede786f3-33ae-4894-843d-af2025f1d5b0",
        "user": {
          "first_name": "Austin",
          "last_name": "Taylor",
          "email": "jessicasimpson@example.com"
        },
        "item_id": "ede786f3-33ae-4894-843d-af2025f1d5b0",
        "created_at": "2021-01-01T00:00:00Z"
      }
    ],
    "attachments": [
      {
        "id": "ede786f3-33ae-4894-843d-af2025f1d5b0",
        "name": "attachment.pdf",
        "user": {
          "first_name": "Austin",
          "last_name": "Taylor",
          "email": "jessicasimpson@example.com"
        },
        "item_id": "ede786f3-33ae-4894-843d-af2025f1d5b0",
        "created_at": "2021-01-01T00:00:00Z"
      }
    ],
    "scores": [
      {
        "score": 95,
        "rating": "A"
      }
    ],
    "business": {
      "name": "Hamilton-Olson",
      "address": "63788 Paige Lane Cooperfurt, MI 10037",
      "phone_number": "955-714-3269",
      "email": "javier01@example.net",
      "website": "https://jones.com/",
      "url": "https://api.baselayer.com/businesses/9083e7e2-1f6b-11ef-8f0f-1edb1b067314",
      "console_url": "https://console.baselayer.com/business/9083e7e2-1f6b-11ef-8f0f-1edb1b067314"
    }
  }
}

Response

Successful Response

{"stackTrail":"webhooks:PortfolioItem.updated:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}