Differences between "on", "onAny" and "receive" #1709

Answered by AaronDewes

Malix-off asked this question in Q&A

Malix-off
Jul 7, 2022

Hello!

What are the differences between "on", "onAny" and "receive" please?

Thanks!

Answered by AaronDewes

on: Listen to a specific event
onAny: Triggers if any event happens

You can read more about these two here: https://probot.github.io/docs/webhooks/

I'm not familiar with receive, but it seems like it allows you to "pretend" an event on GitHub was triggered.

View full answer

Replies: 1 comment 2 replies

AaronDewes
Jul 7, 2022
Maintainer

on: Listen to a specific event
onAny: Triggers if any event happens

You can read more about these two here: https://probot.github.io/docs/webhooks/

I'm not familiar with receive, but it seems like it allows you to "pretend" an event on GitHub was triggered.

2 replies

Malix-off Jul 7, 2022
Author

Ok,
Thanks!

gr2m Jul 8, 2022
Maintainer

receive is an API to programmatically receive an event and hence trigger .on() / .onAny() callbacks. You most likely will never need it. It is useful for testing, or to implement custom events.

Answer selected by Malix-off

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment