{
  "event": "widgetCardView::created",
  "data": {
    "object": "resource",
    "model": "widgetCardView",
    "id": "<string>",
    "fields": {
      "triggeredBy": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "genericContact": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "genericCompany": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "crmOpportunity": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      }
    },
    "createdAt": "2025-03-06T09:05:04.611Z",
    "updatedAt": "2025-03-06T09:15:04.611Z",
    "rawResource": null,
    "warnings": []
  }
}

{
  "cards": [
    {
      "title": "<string>",
      "contents": [
        {
          "type": "text",
          "label": "<string>",
          "value": "<string>",
          "link": "<string>"
        },
        {
          "type": "status",
          "label": "<string>",
          "value": "<string>",
          "status": "<enum: default | success | warning | danger | info>"
        }
      ],
      "actions": [
        {
          "type": "<enum: openUrl | openUrlInIframe>",
          "label": "<string>",
          "url": "<string>"
        }
      ],
      "link": "<string>"
    }
  ],
  "root": {
    "actions": [
      {
        "type": "<enum: openUrl | openUrlInIframe>",
        "label": "<string>",
        "url": "<string>"
      }
    ]
  }
}

​
Event Headers

​
x-conector-id
string
required

The unique identifier of the connector

​
x-owner-id
string
required

The unique identifier of the owner

​
x-idempotency-key
string
required

A unique key to ensure idempotency of the webhook request

​
Event Body

​
event
enum<string>
required

The event type : widgetCardView::created, widgetCardView::updated or widgetCardView::deleted

​
data
Card Resource
required

​
Expected Response

This webhook expects a synchronous response with a JSON body as defined below
​
cards
card[]
required

Array of cards to display in the widget

​
root
object
{
  "event": "widgetCardView::created",
  "data": {
    "object": "resource",
    "model": "widgetCardView",
    "id": "<string>",
    "fields": {
      "triggeredBy": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "genericContact": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "genericCompany": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      },
      "crmOpportunity": {
        "object": "resourceRef",
        "model": "<string>",
        "id": "<string>"
      }
    },
    "createdAt": "2025-03-06T09:05:04.611Z",
    "updatedAt": "2025-03-06T09:15:04.611Z",
    "rawResource": null,
    "warnings": []
  }
}

{
  "cards": [
    {
      "title": "<string>",
      "contents": [
        {
          "type": "text",
          "label": "<string>",
          "value": "<string>",
          "link": "<string>"
        },
        {
          "type": "status",
          "label": "<string>",
          "value": "<string>",
          "status": "<enum: default | success | warning | danger | info>"
        }
      ],
      "actions": [
        {
          "type": "<enum: openUrl | openUrlInIframe>",
          "label": "<string>",
          "url": "<string>"
        }
      ],
      "link": "<string>"
    }
  ],
  "root": {
    "actions": [
      {
        "type": "<enum: openUrl | openUrlInIframe>",
        "label": "<string>",
        "url": "<string>"
      }
    ]
  }
}