Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/donate-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ website immediately, just by copying in a code snippet into your webpage.
[Click here to see a demo](https://embeds.every.org/0.4) showing what it looks
like.

![Gif of donate button usage](../static/img/donate-button.gif)

## Usage

For the latest documentation on how to use the `donate-button`,
Expand Down
8 changes: 6 additions & 2 deletions docs/donate-link.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ primary slug (which you might have if you’re using
[Nonprofit Search API](./endpoints/nonprofit-search.md)) or with the nonprofit’s
EIN.

The Donate Link also works for fundraisers. For multi-nonprofit fundraisers, the `nonprofit-identifier` is `special-fundraiser`.

### Parameters

The link can also be customized with the following URL parameters which control
Expand All @@ -31,8 +33,7 @@ various aspects of the donation experience.

- `min_value` - specify a minimum value for the donation

- `frequency` - specify donation frequency. Allowed values are `ONCE` or
`MONTHLY`
- `frequency` - specify donation frequency. Allowed values are `ONCE`, `MONTHLY`, or `YEARLY`

- `email` - specify donor's email

Expand Down Expand Up @@ -107,3 +108,6 @@ A donate link for GiveDirectly that specifies a monthly donation of $10.
[https://www.every.org/givedirectly?no_exit=true&success_url=https%3A%2F%2Fgivingmultiplier.org#donate](https://www.every.org/givedirectly?no_exit=true&success_url=https%3A%2F%2Fgivingmultiplier.org#donate) -
A donate link that hides the donation modal background and redirects the donor
to givingmultiplier.org when they complete their donation.

[https://www.every.org/givedirectly/f/match-poverty-eradication#donate](https://www.every.org/givedirectly/f/match-poverty-eradication#donate) -
A simple donate link for a fundraiser for GiveDirectly.
4 changes: 4 additions & 0 deletions docs/endpoints/fundraisers.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ nonprofit fundraisers and create new ones.

Enables retrieving details about an existing nonprofit fundraiser.

For multi-nonprofit fundraisers, the `:nonprofitIdentifier` is `special-fundraiser`.

Authentication: [public key](./authentication#public-keys)

#### Usage
Expand All @@ -35,6 +37,8 @@ curl "https://partners.every.org/v0.2/nonprofit/wphfund/fundraiser/wphf-giving-t

Returns details about how much an existing nonprofit fundraiser has raised.

For multi-nonprofit fundraisers, the `:nonprofitIdentifier` is `special-fundraiser`.

Authentication: [public key](./authentication#public-keys)

#### Response format
Expand Down
2 changes: 1 addition & 1 deletion docs/webhooks/_nonprofit-request-format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ properties:
- `currency: <string>`
- Currency code as defined in
[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)
- `frequency: <"Monthly"|"One-time">`
- `frequency: <"Yearly"|"Monthly"|"One-time">`
- `donationDate: <string Date>`
- Date that the donation was initiated
- `publicTestimony: <string | undefined>`
Expand Down
2 changes: 1 addition & 1 deletion docs/webhooks/_partner-request-format.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ properties:
- `currency: <string>`
- Currency code as defined in
[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)
- `frequency: <"Monthly"|"One-time">`
- `frequency: <"Yearly"|Monthly"|"One-time">`
- `donationDate: <string Date>`
- Date that the donation was initiated
- `publicTestimony: <string | undefined>`
Expand Down
13 changes: 1 addition & 12 deletions docs/webhooks/partner-webhook.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,7 @@ Don't know what a webhook is? Learn more from this

## Setting up your webhook

Please email us at [support@every.org](mailto:support@every.org) to set up a
Partner Webhook.

In your email, include:

- A couple sentences about your use case
- Your webhook endpoint

We will then send you a unique `webhook_token` which you can include as a
parameter on your [Donate Link](../donate-link.md). All donations that are made
via your Donate Link with your `webhook_token` will result in a notification
being sent to your webhook.
You set up your webhook URL by signing up for an Every.org account and creating one in the [developer dashboard](https://www.every.org/developer).

## Data format

Expand Down