Respond to important events in near-real-time
Event name | Event key |
---|---|
Snapshot status changed | member_snapshot.status_change |
Snapshot Fulfillment Summary updated | member_snapshot_carrier_fulfillment_status.status_change |
Difference created | difference.created |
Difference marked as a discrepancy | difference.discrepancy |
Difference resolved | difference.resolved |
Difference replaced | difference.replaced |
Group Created | group.created |
Group Connection Request created | group_connection_request.created |
Group Connection Request status changed | group_connection_request.status_change |
Group Disconnection Request created | group_disconnection_request.created |
Group Disconnection Request status changed | group_disconnection_request.status_change |
.created
webhook.
difference.created
event will be sent almost instantly after the snapshot is initially processed. This means you can save individual tracking identifiers for all field-level changes that are in-process.
Note that discrepancies found during carrier syncs will also initiate a difference.created
event, so Noyo suggests calling Get difference to populate all relevant details of the difference, such as its source.
difference.discrepancy
event.
difference.resolved
event.
secret
key. You should choose a random string of text with high entropy. You can use the webhook secret to limit incoming requests to only those originating from Noyo. You may optionally provide an API key name to assist in future key rotationx-noyo-signature
HTTP header. Endpoints should verify each request by: computing an expected HMAC signature for the payload and verifying that the value contained in the x-noyo-signature
header provided by the sender matches the expected signature. Read more.
200
indicating that the event was successfully delivered.
unhealthy
status
active