ProducerSync API

WebhookEventEnvelope

object

Fields common to every ProducerSync webhook event.

idstringrequired

Unique identifier for this event, a TypeID with the whe_ prefix. Repeated on retries — use it to deduplicate.

Example:whe_01m0a149wzf6sb9ap9y8tafwe1

typestringrequired

The specific event type.

timestampstring(date-time)required

UTC time the event was generated. Fractional-second precision is not fixed - parse with a tolerant RFC 3339 parser rather than a fixed-millisecond format.

Example:2026-08-18T08:52:09.2471298Z

Example

UpdatesAvailableEventData

object
runDatestring(date)required

The NIPR run date the completed batch covers. Pass this as updatedSince to fetch only the records that changed.

Example:2025-07-24

Example

UpdatesAvailableWebhookEvent

idstringrequired

Unique identifier for this event, a TypeID with the whe_ prefix. Repeated on retries — use it to deduplicate.

Example:whe_01m0a149wzf6sb9ap9y8tafwe1

typestringrequired

The specific event type.

timestampstring(date-time)required

UTC time the event was generated. Fractional-second precision is not fixed - parse with a tolerant RFC 3339 parser rather than a fixed-millisecond format.

Example:2026-08-18T08:52:09.2471298Z

dataobjectrequired
Show Child Parameters
Example

NpnActivatedEventData

object
npnstringrequired

The National Producer Number added to your monitored population.

Example:15645555

activatedAtstring(date-time)required

UTC time the NPN became active on your account.

Example:2026-08-18T15:53:01.579Z

Example

NpnActivatedWebhookEvent

idstringrequired

Unique identifier for this event, a TypeID with the whe_ prefix. Repeated on retries — use it to deduplicate.

Example:whe_01m0a149wzf6sb9ap9y8tafwe1

typestringrequired

The specific event type.

timestampstring(date-time)required

UTC time the event was generated. Fractional-second precision is not fixed - parse with a tolerant RFC 3339 parser rather than a fixed-millisecond format.

Example:2026-08-18T08:52:09.2471298Z

dataobjectrequired
Show Child Parameters
Example