Meta tags:
description=Implement OAuth2 authorization code flow for beehiiv integrations.;

Headings (most frequently used words):

code, the, authorization, tokens, token, authorize, oauth2, flow, refreshing, utilities, available, scopes, redirect, user, to, your, app, receive, an, exchange, for, call, beehiiv, apis, with, access,

Text of the page (most frequently used words):
badge (186), intent (93), minimal (93), outlined (93), oauth (90), scope (84), info (81), read (57), write (45), subscription (37), list (36), get (30), subscriptions (27), for (17), update (17), newsletter (17), posts (16), post (15), the (14), token (14), warning (14), beta (14), code (13), create (13), webhooks (11), segments (10), newsletter_lists (10), tiers (9), publications (9), automations (9), beehiiv (9), custom_fields (8), oauth2 (8), tier (8), with (7), polls (7), delete (7), authorization (7), custom (7), segment (6), automation (6), authorize (5), page (5), identify (5), example (5), and (5), access (5), tokens (5), api (5), flow (5), field (5), scopes (4), requests (4), available (4), clients (4), client_id (4), redirect_uri (4), app (4), integrations (4), email (4), webhook (4), data (4), deletion (4), this (3), referral_program (3), required (3), actions (3), bearer (3), refresh_token (3), state (3), login (3), your (3), data_deletion (3), condition (3), complimentary (3), bulk (3), resumed (3), paused (3), endpoints (2), metadata (2), introspect (2), revoke (2), utilities (2), confidential (2), client_secret (2), grant_type (2), use (2), refreshing (2), access_token (2), call (2), response (2), public (2), https (2), com (2), response_type (2), send (2), users (2), user (2), implement (2), more (2), demo (2), start (2), trial (2), add (2), referral (2), program (2), publication (2), templates (2), poll (2), lists (2), engagements (2), request (2), fields (2), condition_sets (2), sets (2), complimentary_access (2), status (2), updates (2), journeys (2), authors (2), advertisement (2), opportunities (2), survey (2), deleted (2), rate (2), limiting (2), pagination (2), key (2), getting (2), started (2), search (2), documentation (2), index (2), level (2), llms (2), txt (2), any (2), built, next, previous, yes, was, helpful, optional, default, mutating, put, permits, permission, levels, map, endpoint, each, maps, resource, type, apply, returns, current, checks, activity, revokes, refresh, apis, contains, when, expires_in, token_type, code_verifier, authorization_code, body, application, www, form, urlencoded, exchange, provided, after, consent, redirects, receive, wdgkdt_bhoxufwrhgf2ovkzmfhq9r_erd01ipmz_boc, http, 2flocalhost, 3a3008, 2fcallback, 3aread, 12345678, code_challenge_method, code_challenge, recommended, csrf, protection, space, delimited, redirect, guide, will, walk, you, through, steps, integration, are, served, under, namespace, domain, looking, integrate, seamlessly, supports, standard, information, about, registering, client, contact, support, copy, scroll, top, light, workspace, tag, subscriber, ids, subscribers, recalculate, test, aggregate, stats, responses, set, emails, journey, author, submitted, added, downgraded, upgraded, confirmed, created, scheduled, updated, sent, unsubscribed, subscribed, workspaces, tags, reference, authorizations, welcome, ask, agents, root, append, url, markdown, version, developer,

Text of the page (random words):
oauth2 beehiiv developer documentation for ai agents a documentation index is available at the root level at llms txt append llms txt to any url for a page level index or md for the markdown version of any page search ask ai login start trial get a demo search welcome getting started create an api key pagination rate limiting no code integrations webhooks newsletter list subscription post subscription survey oauth2 authorizations tokens api reference advertisement opportunities authors automation journeys automations bulk subscriptions bulk subscription updates complimentary access condition sets custom fields data deletion engagements newsletter lists newsletter list subscriptions oauth users polls posts post templates publications referral program segments subscriptions subscription tags tiers webhooks workspaces getting started create an api key pagination rate limiting no code integrations webhooks newsletter list subscription subscribed badge intent warning minimal outlined beta badge newsletter list subscription unsubscribed badge intent warning minimal outlined beta badge newsletter list subscription paused badge intent warning minimal outlined beta badge newsletter list subscription resumed badge intent warning minimal outlined beta badge post sent post updated post scheduled subscription created subscription confirmed subscription deleted subscription upgraded subscription downgraded subscription paused subscription resumed subscription tier paused subscription tier resumed subscription tier added subscription tier deleted survey response submitted oauth2 authorize create token revoke token introspect token get token info get advertisement opportunities badge intent info minimal outlined oauth scope posts read badge list authors get author add subscription to an automation badge intent info minimal outlined oauth scope automations write badge list automation journeys badge intent info minimal outlined oauth scope automations read badge get automation journey badge intent info minimal outlined oauth scope automations read badge list automations badge intent info minimal outlined oauth scope automations read badge get automation badge intent info minimal outlined oauth scope automations read badge list automation emails bulk create subscription badge intent info minimal outlined oauth scope subscriptions write badge list subscription updates badge intent info minimal outlined oauth scope subscriptions read badge get subscription update badge intent info minimal outlined oauth scope subscriptions read badge update subscriptions badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions status badge intent info minimal outlined oauth scope subscriptions write badge update subscriptions status badge intent info minimal outlined oauth scope subscriptions write badge list complimentary access badge intent info minimal outlined oauth scope complimentary_access read badge get complimentary access badge intent info minimal outlined oauth scope complimentary_access read badge list condition sets badge intent info minimal outlined oauth scope condition_sets read badge get condition set badge intent info minimal outlined oauth scope condition_sets read badge create custom field badge intent info minimal outlined oauth scope custom_fields write badge get custom field badge intent info minimal outlined oauth scope custom_fields read badge list custom fields badge intent info minimal outlined oauth scope custom_fields read badge update custom field badge intent info minimal outlined oauth scope custom_fields write badge update custom field badge intent info minimal outlined oauth scope custom_fields write badge delete custom field badge intent info minimal outlined oauth scope custom_fields write badge create data deletion request badge intent info minimal outlined oauth scope data_deletion write badge get data deletion request badge intent info minimal outlined oauth scope data_deletion read badge list data deletion requests badge intent info minimal outlined oauth scope data_deletion read badge get publication engagements badge intent info minimal outlined oauth scope publications read badge list newsletter lists badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge get newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge create newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge update newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge delete newsletter list badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge create newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge list newsletter list subscriptions badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge get newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists read badge update newsletter list subscription badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge update newsletter list subscription by subscription id badge intent warning minimal outlined beta badge badge intent info minimal outlined oauth scope newsletter_lists write badge identify user badge intent info minimal outlined oauth scope identify read badge list polls badge intent info minimal outlined oauth scope polls read badge get poll badge intent info minimal outlined oauth scope polls read badge list poll responses badge intent info minimal outlined oauth scope polls read badge create post badge intent info minimal outlined oauth scope posts write badge update post badge intent info minimal outlined oauth scope posts write badge list posts badge intent info minimal outlined oauth scope posts read badge get aggregate stats badge intent info minimal outlined oauth scope posts read badge get post badge intent info minimal outlined oauth scope posts read badge delete post badge intent info minimal outlined oauth scope posts write badge send test email badge intent info minimal outlined oauth scope posts badge get post templates badge intent info minimal outlined oauth scope posts read badge list publications badge intent info minimal outlined oauth scope publications read badge get publication badge intent info minimal outlined oauth scope publications read badge get referral program badge intent info minimal outlined oauth scope referral_program read badge create segment list segments badge intent info minimal outlined oauth scope segments read badge get segment badge intent info minimal outlined oauth scope segments read badge recalculate segment badge intent info minimal outlined oauth scope segments write badge list segment subscribers badge intent info minimal outlined oauth scope segments read badge list segment subscriber ids badge intent info minimal outlined oauth scope segments read badge delete segment badge intent info minimal outlined oauth scope segments write badge create subscription badge intent info minimal outlined oauth scope subscriptions write badge list subscriptions badge intent info minimal outlined oauth scope subscriptions read badge get subscription by email badge intent info minimal outlined oauth scope subscriptions read badge get subscription by id badge intent info minimal outlined oauth scope subscriptions read badge update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge update subscription by id badge intent info minimal outlined oauth scope subscriptions write badge update subscription by email badge intent info minimal outlined oauth scope subscriptions write badge delete subscription badge intent info minimal outlined oauth scope subscriptions write badge add subscription tag badge intent info minimal outlined oauth scope subscriptions write badge create a tier badge intent info minimal outlined oauth scope tiers write badge list tiers badge intent info minimal outlined oauth scope tiers read badge get tier badge intent info minimal outlined oauth scope tiers read badge update a tier badge intent info minimal outlined oauth scope tiers write badge update a tier badge intent info minimal outlined oauth scope tiers write badge create a webhook badge intent info minimal outlined oauth scope webhooks write badge list webhooks badge intent info minimal outlined oauth scope webhooks read badge get webhook badge intent info minimal outlined oauth scope webhooks read badge update webhook badge intent info minimal outlined oauth scope webhooks write badge delete a webhook badge intent info minimal outlined oauth scope webhooks write badge identify workspace badge intent info minimal outlined oauth scope identify read badge get publications by subscription email badge intent info minimal outlined oauth scope publications read badge login start trial get a demo light on this page authorization code flow refreshing tokens token utilities available scopes scroll to top oauth2 copy page implement oauth2 authorization code flow for beehiiv integrations for more information about registering an oauth client contact beehiiv support for integrations looking to integrate more seamlessly with beehiiv the beehiiv api supports the standard oauth2 authorization code flow oauth2 endpoints are served under the oauth namespace on the app domain for example https app beehiiv com oauth this guide will walk you through the steps to implement the oauth2 authorization code flow for your integration authorization code flow 1 redirect the user to authorize your app send users to get oauth authorize with client_id redirect_uri response_type code scope space delimited state recommended for csrf protection code_challenge and code_challenge_method required for public clients example https app beehiiv com oauth authorize client_id wdgkdt_bhoxufwrhgf2ovkzmfhq9r_erd01ipmz_boc redirect_uri http 3a 2f 2flocalhost 3a3008 2fcallback response_type code scope posts 3aread state 12345678 2 receive an authorization code after login and consent beehiiv redirects to your redirect_uri with code state if provided 3 exchange the code for tokens call post oauth token with application x www form urlencoded body grant_type authorization_code code redirect_uri client_id client_secret confidential clients code_verifier required for public clients the response contains access_token token_type expires_in and refresh_token when available 4 call beehiiv apis with the access token use the token as a bearer token in api requests authorization bearer access_token refreshing tokens use post oauth token with grant_type refresh_token refresh_token client_id client_secret confidential clients token utilities post oauth revoke revokes access or refresh tokens post oauth introspect checks token activity and metadata get oauth token info returns metadata for the current bearer token available scopes each scope maps to a resource type for example posts scopes apply to posts endpoints scope permission levels map to endpoint actions read permits read actions for example get requests write is required for mutating actions for example post put and delete requests default scope identify read optional scopes automations read automations write custom_fields read custom_fields write subscriptions read subscriptions write polls read polls write posts read posts write publications read publications write referral_program read referral_program write segments read segments write tiers read tiers write webhooks read webhooks write was this page helpful yes no previous authorize next built with