Can a plugin add a webhook?

Разработка
1

I’m working on a plugin that communicates with an external web app. The web app is also informed of changes in Discourse through the use of webhooks.
Right now, installing the plugin is complicated, because it requires to also manually set up the webhooks. Is there a way my plugin could set up the webhooks itself?

2

I’m not much of a plugin author, but I’m pretty sure that you can call something like

hook = WebHook.new(payload_url: "https://sefsdf", secret: "lkjlkjlkj", active: true)
hook.save

Here are the other things in a webhook that you may or may not need to set.

 id: nil,
 payload_url: nil,
 content_type: 1,
 last_delivery_status: 1,
 status: 1,
 secret: "",
 wildcard_web_hook: false,
 verify_certificate: true,
 active: false,
 created_at: nil,
 updated_at: nil>
3

Ah that would only create a web hook record in the database but doesn’t enqueue any jobs.

What kind of custom fields/webhook are you sending to your web app? You could subscribe to certain DiscourseEvents and add a custom Sidekiq job which calls an API on your web app.

4

Thanks @tgxworld. I’ve seen examples of how to use DiscourseEvents to emulate Discourse native webhooks here and here. I will try to do that if there’s no other choice.

But this seems complex. I would love to have a one-liner, like what @pfaffman proposed. When you use the UI or the API to create a webhook, doesn’t Discourse call an internal function I could also use from my plugin.rb file?

5

Is this a call to the kind of internal function I’ve just mentioned?

6

If you want to invoke a webhook when certain internal event happens, here it is the example. GitHub - erickguan/discourse-user-created-webhook · GitHub.
If you want to add a new type of webhook, here it is the example. GitHub - erickguan/discourse-webhooks-example · GitHub

7

Thanks a lot @fantasticfears, I will try this.

8

Вот что я в итоге сделал:

Так как мне нужны стандартные уведомления о создании и удалении тем, я понял, что Discourse уже ставит их в очередь как часть стандартной функции вебхуков. Поэтому делать это вручную не нужно.

Осталось сделать то, что предложил @pfaffman: добавить вебхук в базу данных. Однако предложенный код молча не срабатывает, вероятно, из-за отсутствующих и/или неверных параметров.

Вот мой полный рабочий код:

#customization:plugin.rb

# Автоматически добавляем наш вебхук, чтобы администратору не приходилось делать это вручную
after_initialize do
	# Удаляем наш ранее установленный вебхук (зарезервированный id = 1000)
	WebHook.where(id: 1000).destroy_all

	# Создаем вебхук (зарезервированный id = 1000)
	hook = WebHook.new(
		id: 1000,							# Наш зарезервированный id						
		payload_url: 'https://hfzeoihifzh/',
		content_type: 1,					# 1 = 'application/json'
		secret: "min12characters",
		active: true,
		verify_certificate: true,
		web_hook_event_type_ids: [1]		# 1 = события тем
	)
	hook.save	
end