Open
Conversation
Member
Crashdoom
commented
Aug 25, 2022
Crashdoom
commented
- Add about webhooks page
- Add some webhook events and payloads
- Add info on validating payloads and JWTs
- Fix spelling error
- Fix CSS
- Add about webhooks page - Add some webhook events and payloads - Add info on validating payloads and JWTs - Fix spelling error - Fix CSS
- Add additional event types - Fix formatting issues
Deploying with
|
| Latest commit: |
a5e4528
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d9beb1d4.concat-docs.pages.dev |
| Branch Preview URL: | https://docs-webhooks.concat-docs.pages.dev |
SimonSchick
requested changes
Aug 25, 2022
SimonSchick
left a comment
SimonSchick
left a comment
There was a problem hiding this comment.
There is too much spacing on the page which leads to the code sections being squashed/compressed
| Each POST request will include the following headers: | ||
|
|
||
| <attribute id="ep-ch-user-agent" name="user-agent" type="string" response> | ||
| The HTTP client used to send the request. This will always be <code>ConCat/AxiosHTTPClient</code>. |
There was a problem hiding this comment.
This shouldn't really matter for authenticating webhook requests and I don't think we should include that here as some people might start to depend on it incorrectly as an 'identification' step.
| The HTTP client used to send the request. This will always be <code>ConCat/AxiosHTTPClient</code>. | ||
| </attribute> | ||
| <attribute id="ep-ch-authorization" name="authorization" type="string" response> | ||
| A bearer token with a signed JWT payload containing a base64-encoded sha256 hash of the <code>data</code> property. See <link to="/docs/api/webhooks/validating"><strong>Validating Payloads</strong></link> for more information. |
There was a problem hiding this comment.
Also consider adding links to jwt spec etc just to make this clearer.
| </div> | ||
| <div> | ||
| <exampleBox header='Response' headerSubText='application/json'> | ||
| {`{ |
There was a problem hiding this comment.
Can we potentially store these in separate files?
| <parentAttribute id="ep-et-vu-volunteer" name="volunteer" type="object" response> | ||
| <span>The volunteer record containing the user's application.</span> | ||
| <> | ||
| <attribute id="ep-et-vu-v-id" name="id" type="string" response> |
There was a problem hiding this comment.
I'm a little worried this is going to become extremely repetitive very quickly which will potentially add to copy/paste errors.
|
|
||
| ## JWT format | ||
|
|
||
| The JWT payload will contain the following properties: |
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
2 participants
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.