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

How to write a webhook receiver #103

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

How to write a webhook receiver #103

wants to merge 11 commits into from

Conversation

Tijani-Dia
Copy link
Collaborator

Targets #94.

I will add how to write a websocket publisher in another PR.

@codecov-commenter
Copy link

codecov-commenter commented Aug 17, 2021

Codecov Report

Merging #103 (6aea00a) into main (6919766) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #103   +/-   ##
=======================================
  Coverage   96.72%   96.72%           
=======================================
  Files          41       41           
  Lines        1100     1100           
  Branches      104      104           
=======================================
  Hits         1064     1064           
  Misses         30       30           
  Partials        6        6           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6919766...6aea00a. Read the comment docs.

@Stormheg Stormheg self-requested a review August 18, 2021 08:31
Copy link
Member

@Stormheg Stormheg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have read the how to tutorial and it looks good, thanks @Tijani-Dia !

One suggestion to add an overview at the beginning of the document to set expectations.


First, let's define the `webhook_url` that the input source uses to send us new updates.

The base path of this url is `/wagtail_live/`. We need to specify an additional path parameter that is specific to an input source.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The base path of this url is /wagtail_live/.

This assumes the same url path as in the tutorial was chosen right? Should we make that clear?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand what you mean.

docs/howto/webhook_receiver.md Show resolved Hide resolved
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

Successfully merging this pull request may close these issues.

Add documentation for writing your own receivers and publishers
3 participants