This webhook triggers when a Periodic Insight Summary finishes generating e.g. weekly summary.

Event Message

The table below describes the structure of the event.

Field	Description	Values
`customer_id`	The customer identifier that this event relates to
`created_at`	An RFC3339 timestamp of the generation time
`summary_details`	The details of the generation
`summary_details.granularity`	The period which the summary was generated for	`daily`, `weekly`, `biweekly`, `monthly`, `quarterly`, `six_monthly`, `annually`
`summary_details.start`	Timestamp for the beginning of the summary period
`summary_details.end`	Timestamp for the end of the summary period
`summary_details.summary_id`	Unique identifier for the generated summary

Examples

{
  "customer_id": "e3fb40ca-9596-4fde-8361-23889139d6fc",
  "created_at": "2024-12-12T11:45:47Z",
  "summary_details": {
    "granularity": "weekly",
    "start": "2024-12-02T00:00:00Z",
    "end": "2024-12-08T23:59:59Z",
    "summary_id": "a02fd1e0-0e4e-49ec-a160-7a1a279d8b72"
  }
}

How And When Is This Event Triggered

Legend

Icon	Description
	Summaries are generated once the week summary period has finished.
	There must be enough data for at least 5 cards to create a valid summary.