Repository navigation
docs(custom-events): seeds, field types, payload mode and event state (PDI-2712) - #193
Merged
Merged
Conversation
Custom event authors could not work out from the docs why their preview failed or what their event sent (PDI-2712): - A custom event and its seed belong to one organization; an ID from another organization or sandbox is not found. - Field types must match the stored values; how to convert, and how empty optional fields are left out. - `mapping.payload`: `extend` carries the complete entities (including personal data), `replace` only the mapped fields, with a "good to know" note on when to use which. - What `event_status`, `enabled` and `auto_trigger` mean, and why a draft-phase response shows draft/false/false. - Preview `warnings` and the `issues` on every 400. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Q8ogdv74mD5Ggwi1RN2Rf
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Q8ogdv74mD5Ggwi1RN2Rf
karlrank
marked this pull request as ready for review
November 20, 2026 11:15
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Docs part of PDI-2712. Badenova followed the custom events docs and still needed a call to find out why their preview failed and why it returned the whole contact. This updates
docs/integrations/custom-events.mdonly:stringfield and the event is rejected; convert with$string(...)or declare the stored type. Empty optional fields are left out; required ones fail.mapping.payloadfor the first time.extend(default, "Add to the entity data") carries the complete entities with every attribute;replace("Only the mapped fields") sends only the mapped fields. A neutral:::info Good to knownote says that this can include personal data, that it suits most integrations, and when to usereplace.enabledandauto_trigger(new subsection under Lifecycle): what each answers, and why responses from the draft phase showdraft/false/false; read the live state withGET /v1/events/{event_name}.warningson 200, and a table of 400s (Seed entity not found in this organization,Seed entity has the wrong schema, schema validation, projection) with theissuesbody. Trigger and validation sections point to the sameissuesshape.replace.Merge after
The preview
warnings, the seed errors and theissuesbody ship with https://gitlab.com/e-pilot/product/events-automation/event-catalog-api/-/merge_requests/86. The builder behaviour mentioned in step 4 (search by ID, type and empty-field hints) ships with https://gitlab.com/e-pilot/product/360-portal/epilot360-event-catalog/-/merge_requests/37. Merge this once both are on prod.Test plan
onBrokenLinks: throw); the new anchors are same-pageGenerated by Claude Code