Skip to content

Commit

Permalink
feat(integrations): add support for beehiiv (#3007)
Browse files Browse the repository at this point in the history
## Describe your changes

- Add support for Beehiv

## Issue ticket number and link

## Checklist before requesting a review (skip if just adding/editing
APIs & templates)
- [ ] I added tests, otherwise the reason is: 
- [ ] I added observability, otherwise the reason is:
- [ ] I added analytics, otherwise the reason is:

Co-authored-by: Hassan Wari <hassanwari@Hassans-MacBook-Pro.local>
  • Loading branch information
hassan254-prog and Hassan Wari authored Nov 18, 2024
1 parent 92eaf84 commit c465894
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs-v2/integrations/all/beehiiv.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Beehiiv
sidebarTitle: Beehiiv
---

API configuration: [`beehiiv`](https://nango.dev/providers.yaml)

## Features

| Features | Status |
| - | - |
| [Auth (API Key)](/integrate/guides/authorize-an-api) ||
| [Sync data](/integrate/guides/sync-data-from-an-api) ||
| [Perform workflows](/integrate/guides/perform-workflows-with-an-api) ||
| [Proxy requests](/integrate/guides/proxy-requests-to-an-api) ||
| [Receive webhooks](/integrate/guides/receive-webhooks-from-an-api) | 🚫 (time to contribute: &lt;48h) |

<Tip>We can implement missing features in &lt;48h, just ask for it in the [community](https://nango.dev/slack).</Tip>

## Getting started

- [How to create an API Key](https://developers.beehiiv.com/welcome/create-an-api-key)
- [Beehiiv API docs](https://developers.beehiiv.com/api-reference/automation-journeys/create)

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

## API gotchas

- Beehiiv uses `API_KEY` auth mode with `Authorization: Bearer ${apiKey}` in the request header to access different endpoints.
- When creating a new connection in Nango, please add your `publicationId` which will be used to identify your publication when you’re using Beehiiv API, you can obtain this within the API page.

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/beehiiv.mdx)</Note>
1 change: 1 addition & 0 deletions docs-v2/integrations/communication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ sidebarTitle: Communication
<CardGroup cols={4}>
<Card title="Aircall" href="/integrations/all/aircall" color="#68a063" />
<Card title="Atlassian" href="/integrations/all/atlassian" color="#68a063" />
<Card title="Beehiiv" href="/integrations/all/beehiiv" color="#68a063" />
<Card title="Chorus" href="/integrations/all/chorus" color="#68a063" />
<Card title="Circle.so" href="/integrations/all/circle-so" color="#68a063" />
<Card title="Dialpad" href="/integrations/all/dialpad" color="#68a063" />
Expand Down
1 change: 1 addition & 0 deletions docs-v2/integrations/marketing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ sidebarTitle: Marketing

<CardGroup cols={4}>
<Card title="Facebook" href="/integrations/all/facebook" color="#68a063" />
<Card title="Beehiiv" href="/integrations/all/beehiiv" color="#68a063" />
<Card title="Bitly" href="/integrations/all/bitly" color="#68a063" />
<Card title="Clari Copilot" href="/integrations/all/clari-copilot" color="#68a063" />
<Card title="Emarsys" href="/integrations/all/emarsys" color="#68a063" />
Expand Down
1 change: 1 addition & 0 deletions docs-v2/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,7 @@
"integrations/all/autodesk",
"integrations/all/bamboohr",
"integrations/all/battlenet",
"integrations/all/beehiiv",
"integrations/all/blandai",
"integrations/all/bigcommerce",
"integrations/all/bitbucket",
Expand Down
29 changes: 29 additions & 0 deletions packages/shared/providers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -660,6 +660,35 @@ battlenet:
example: com
pattern: '^[a-z.]+$'

beehiiv:
display_name: Beehiiv
categories:
- communication
- marketing
auth_mode: API_KEY
proxy:
headers:
Authorization: Bearer ${apiKey}
base_url: https://api.beehiiv.com/v2/publications/${connectionConfig.publicationId}
verification:
method: GET
endpoint: /posts
docs: https://docs.nango.dev/integrations/all/beehiiv
credentials:
apiKey:
type: string
title: API Key
description: The API key for your Beehiiv account
example: 8ab3sjxqvHzyUnP9JhvlfT6C0wsbgr5XQrpaZZjxJkYBPy6sntvT1M2Lk94VQeRb
pattern: '^[a-zA-Z0-9]{64}$'
connection_config:
publicationId:
type: string
title: Publication Id
description: The prefixed ID of the publication object
example: pub_a3d1b49e-2a5d-4f4b-97c8-8f32e1d2f7b9
pattern: '^(pub_[0-9a-fA-F\-]+)$'

bigcommerce:
display_name: BigCommerce
categories:
Expand Down
1 change: 1 addition & 0 deletions packages/webapp/public/images/template-logos/beehiiv.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c465894

Please sign in to comment.