Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

spec: recommend id in webhook payload #30

Open
aranw opened this issue Dec 7, 2023 · 1 comment
Open

spec: recommend id in webhook payload #30

aranw opened this issue Dec 7, 2023 · 1 comment

Comments

@aranw
Copy link

aranw commented Dec 7, 2023

I think it would be a good idea to include the webhook-id in the webhook payload as a required field. Consumers have an additional confirmation then that the webhook-id matches the id found in the webhook payload

For example based on the spec:

Headers:
webhook-id: msg_2KWPBgLlAfxdpx2AI54pPJ85f4W\

Request Body:

{
  "id": "msg_2KWPBgLlAfxdpx2AI54pPJ85f4W\",
  "type": "contact.created",
  "timestamp": "2022-11-03T20:26:10.344522Z",
  "data": {
    "id": "1f81eb52-5198-4599-803e-771906343485"
  }
}

Edit: rather than say required field I should of said recommended field as the payload section is only a suggestion

@aranw aranw changed the title spec: require id in webhook payload spec: recommend id in webhook payload Dec 8, 2023
@zekth
Copy link
Member

zekth commented Dec 12, 2023

I think this issue also falls into this: #15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants