Skip to content

Webhooks

Webhook event reference

Payload fields for every supported webhook event.

On this page

See signature verification and delivery policy before processing events.

meeting.completed

A meeting has finished and its summary is ready. The existing contract includes the host's transcript.

Contract version: legacy.

{
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "const": "meeting.completed"
    },
    "deliveryId": {
      "type": "string"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "webhookId": {
      "type": "string"
    },
    "test": {
      "type": "boolean",
      "const": true
    },
    "data": {
      "type": "object",
      "properties": {
        "meeting": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "title": {
              "type": "string"
            },
            "type": {
              "type": "string"
            },
            "startedAt": {
              "type": "string",
              "format": "date-time"
            },
            "endedAt": {
              "type": "string",
              "format": "date-time"
            },
            "owner": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id"
              ],
              "additionalProperties": false
            },
            "attendees": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              }
            },
            "summary": {
              "type": "string",
              "description": "Summary rendered as HTML."
            },
            "transcript": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "speaker": {
                    "type": "string"
                  },
                  "text": {
                    "type": "string"
                  },
                  "timestamp": {
                    "type": "string"
                  }
                },
                "required": [
                  "text"
                ],
                "additionalProperties": false
              }
            }
          },
          "required": [
            "id",
            "owner",
            "attendees",
            "transcript"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "meeting"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "event",
    "deliveryId",
    "timestamp",
    "webhookId",
    "data"
  ],
  "additionalProperties": false
}

resource.created

A published shared resource was created or made shared.

Contract version: v1.

{
  "type": "object",
  "properties": {
    "event_id": {
      "type": "string",
      "description": "Stable event identity. Deduplicate on this value, including replays."
    },
    "event": {
      "type": "string",
      "const": "resource.created"
    },
    "version": {
      "type": "string",
      "const": "v1"
    },
    "occurred_at": {
      "type": "string",
      "format": "date-time"
    },
    "resource": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "version": {
          "type": "string",
          "description": "Opaque resource revision. Events may arrive out of order."
        }
      },
      "required": [
        "id",
        "type",
        "version"
      ],
      "additionalProperties": false
    },
    "changed_fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Names of externally exposed fields changed by this commit. Never field values."
    },
    "test": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "event_id",
    "event",
    "version",
    "occurred_at",
    "resource"
  ],
  "additionalProperties": false
}

resource.updated

An externally exposed field on a published shared resource changed.

Contract version: v1.

{
  "type": "object",
  "properties": {
    "event_id": {
      "type": "string",
      "description": "Stable event identity. Deduplicate on this value, including replays."
    },
    "event": {
      "type": "string",
      "const": "resource.updated"
    },
    "version": {
      "type": "string",
      "const": "v1"
    },
    "occurred_at": {
      "type": "string",
      "format": "date-time"
    },
    "resource": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "version": {
          "type": "string",
          "description": "Opaque resource revision. Events may arrive out of order."
        }
      },
      "required": [
        "id",
        "type",
        "version"
      ],
      "additionalProperties": false
    },
    "changed_fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Names of externally exposed fields changed by this commit. Never field values."
    },
    "test": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "event_id",
    "event",
    "version",
    "occurred_at",
    "resource"
  ],
  "additionalProperties": false
}

resource.deleted

A published shared resource was deleted or made private. Remove it from your local copy.

Contract version: v1.

{
  "type": "object",
  "properties": {
    "event_id": {
      "type": "string",
      "description": "Stable event identity. Deduplicate on this value, including replays."
    },
    "event": {
      "type": "string",
      "const": "resource.deleted"
    },
    "version": {
      "type": "string",
      "const": "v1"
    },
    "occurred_at": {
      "type": "string",
      "format": "date-time"
    },
    "resource": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "version": {
          "type": "string",
          "description": "Opaque resource revision. Events may arrive out of order."
        }
      },
      "required": [
        "id",
        "type",
        "version"
      ],
      "additionalProperties": false
    },
    "changed_fields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Names of externally exposed fields changed by this commit. Never field values."
    },
    "test": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "event_id",
    "event",
    "version",
    "occurred_at",
    "resource"
  ],
  "additionalProperties": false
}

Search by operation name or what you want to build.

Use arrow keys to browse. Enter opens a result.