Skip to content

Latest commit

 

History

History
69 lines (54 loc) · 2.71 KB

embed-contribution-flow.md

File metadata and controls

69 lines (54 loc) · 2.71 KB
Raw
description
To integrate a "Contribute" option directly on your website

Embed contribution flow

{% hint style="warning" %} This feature is currently in a beta-test phase. If you face any issue or need assistance, you can send a message on Slack (#embed-contribution-flow channel) {% endhint %}

The embed contribution flow is a way to integrate Open Collective on your own website. Visitors will be able to contribute directly, by simply providing an email address.

Embedded contribution on the website of an initiative

General considerations

  • The widget will look better if it has some space, ideally the full page height & width
  • The following URL parameters can be used to configure your integration:
Parameter Value type Default value Description
useTheme Boolean true

By default, the theme of your profile (defined by your primary color) will be used. If you rather want to use the default Open Collective theme, set this to false.
hideHeader Boolean false Set this to true to hide the header at the top

Embed the default tier (Donate)

The simplest way to embed the contribution flow is by using the /donate URL (e.g. https://opencollective.com/babel/donate). Just replace COLLECTIVE_SLUG by your collective slug below:

<iframe src="https://opencollective.com/embed/COLLECTIVE_SLUG/donate" style="width: 100%; min-height: 100vh;"></iframe>

Embed a specific tier

To embed a specific tier, you'll need to know its ID. For that, go to your profile page, click on "Contribute" for the tier you want to embed then check the URL. It should look like https://opencollective.com/COLLECTIVE_SLUG/contribute/TIER_SLUG-TIER_ID/checkout

From this URL, you can deduct the embedded one (prefix with embed and removes /checkout):

<iframe src="https://opencollective.com/embed/COLLECTIVE_SLUG/contribute/TIER_SLUG-TIER_ID" style="width: 100%; min-height: 100vh;"></iframe>