Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 3.17 KB

integrations.md

File metadata and controls

77 lines (47 loc) · 3.17 KB

Integrations

Twitter Integration

Connect your Twitter to automatically thank new backers who contribute to your Collective.

Go to "edit Collective" > "Connected Accounts" and click the "Connect Twitter" button.

Chat Integrations

You can set up Open Collective notifications in your Slack or Gitter channel. First set up a webhook, described below, and then send it to us and we'll add the hook to our platform.

Slack Webhook

  • In Slack, select menu Apps & Integrations
  • Click Build Your Own > Make a Custom Integration > Incoming WebHooks
  • Choose a channel, or create a new channel, where the notifications will be sent
  • Click Add Incoming WebHooks Integration

Gitter Webhook

  • Go to your room's integrations and click Open Collective
  • Copy the provided Webhook URL and click Done

Webhooks (beta)

Webhooks are currently tested with a limited number of users. Contact us if you want webhooks to be enabled for your collective.

{% hint style="warning" %} The data posted on the webhooks matches the permissions of the admin of the collective. They can therefore include personal information, like the email of the contributor who submit an expense to the collective. In short, don't post the payload on untrustable or publicly viewable services. {% endhint %}

The following guide demonstrate how to add a webhook for your collective.Start by going to https://zapier.com/app/home then login with your Zapier account. Then click on Make a zap!

Click on "Mape a Zap!"

In the App type, select Webhooks

Select "Catch Hook" then click on "Save + Continue"

Copy the link provided by Zapier

Go to your collective "Edit" section, then select webhooks. Add the URL provided by Zapier and select the webhook type directly from the list (or all to subscribe to all notifications).

Click on Save, finish the configuration on Zapier.com and that's is!

For Admins

The webhook can be added in the database Notifications table:

INSERT INTO "Notifications" (
  "GroupId",
  channel,
  type,
  active,
  "webhookUrl")
VALUES ((SELECT id from "Groups" where slug = '<group slug>'),
        '<channel: either slack or gitter',
        '<type: see note below>',
        true,
        '<webhook URL>');

type (would actually be more properly named activity) can be:

  • either 'all' (*) to send notifications for all activities (group transaction created, payment received from Stripe, etc)
  • or some constant from here to only send notifications for a specific activity

Some activities are not linked to any group and will therefore be ignored.