Event types

Every webhook request carries one event. type names it, and data holds the resources it concerns, such as the review and the customer's profile.

Every event body has the same top-level fields: type, id, created_at, version, origin and data. Each event page shows an example and describes every field.

• Switch on type to decide how to handle the event.
• id is also sent as the webhook-id header. Store the IDs you have processed and skip repeats.
• Cevoid sends the body with its object keys sorted. Parse it as JSON; do not depend on the key order.

Each event has its own page with an example and every field. A destination can subscribe to any of them, except those marked Flow only: review replies and the review and upload requests come only from a Flow. See Send from a Flow.

• post.approvedA post was approved. Each approval sends a new event, including a post added as approved, so act once per post id.
• upload.completedA shopper finished uploading content.
• content-upload-request.createdFlow onlyA Flow asked a shopper to upload photos or videos.

• profile.program-joinedA profile joined the loyalty program.
• profile.program-leftA profile left the loyalty program.
• tier.earnedA member reached a tier.
• tier.evaluation-approachingA member's tier evaluation is coming up.
• reward.fulfilledA member received one or more rewards.
• points.expiration-approachingSome of a member's points expire soon.

• product-review.submittedA shopper submitted a product review. Imported reviews are not included.
• company-review.submittedA shopper submitted a company review. Imported reviews are not included.
• product-review.repliedFlow onlyA reply was added to a product review.
• company-review.repliedFlow onlyA reply was added to a company review.
• product-review-request.createdFlow onlyA Flow asked a shopper to review the products in an order.
• company-review-request.createdFlow onlyA Flow asked a shopper to review the store.

The test event, cevoid.test, is described in Test a webhook.

• Check for each resource. data leaves out resources your plan does not include, and points and tier appear only on loyalty and order events, and only when the profile is a loyalty member. A resource Cevoid cannot read is left out rather than sent half filled.
• Read at the first attempt. data reflects the records when Cevoid made the first attempt; retries resend that body unchanged.

• version is 1 for every event today. Read it with type before you process an event.
• The API resources in data follow the API's compatibility rules: within v2 they gain optional fields over time, without a change to version. See API versioning.
• New event types can appear. Ignore a type your receiver does not handle and still return a 2xx status, so the delivery does not retry.
• Ignore fields you do not recognize instead of rejecting the body.