Skip to content

Commit 1ad088a

Browse files
committed
docs(webhooks): distinguish schema identifiers
1 parent 44473a2 commit 1ad088a

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

webhooks/managing-webhooks.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ curl -X POST "https://spectrum.photon.codes/projects/$PROJECT_ID/webhooks/" \
3131
Standard Webhooks signatures. Choose `normalized-events.v1` only when you need
3232
the original normalized Spectrum event shape.
3333

34+
This management field is a string endpoint schema ID. It is distinct from the
35+
numeric `schemaVersion: 1` inside a delivered raw event, which identifies only
36+
the revision of that envelope. Do not send the numeric value to this API or
37+
compare the two fields.
38+
3439
The create response is the only time both `signingSecret` and
3540
`standardSigningSecret` are returned. Store both before discarding the response.
3641
For a `normalized-events.v1` endpoint, use `signingSecret` for current

webhooks/troubleshooting.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Check the endpoint record first:
1616

1717
- `enabled` must be `true` and `status` must be `active`.
1818
- `eventTypes` must include `message.received`.
19-
- `schemaVersion` should be `raw-inbound.v1` for Standard Webhooks delivery.
19+
- The endpoint record's string `schemaVersion` must be `raw-inbound.v1` for
20+
Standard Webhooks delivery. It is distinct from the delivered raw envelope's
21+
numeric `schemaVersion: 1`.
2022
- The event must belong to the same project as the registration.
2123

2224
Then check the destination:

0 commit comments

Comments
 (0)