Skip to main content

autessa.beehiiv

6 methods in the beehiiv namespace.

autessa.beehiiv.connectors.allREAD

autessa.beehiiv.connectors.all()

List every beehiiv connector you can access in your company.

Returns all beehiiv connectors in your current company that you have at least READ access to, newest-relevant first. Use a connector's connectorId with the other beehiiv.connectors.* methods. Credentials are never included in the returned DTOs.

Request fields

No fields.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connectors
    Type
    BeehiivConnectorDto[]
    Description

autessa.beehiiv.connectors.createMUTATE

autessa.beehiiv.connectors.create({ connectorName, apiKey })

Create a beehiiv connector from an API key.

Stores a beehiiv API key as a new connector for your company. HIGH risk: it persists a credential that grants access to the beehiiv account's publications and subscribers. Validate the key first with connectors.testConnection. The key is stored encrypted and never returned.

Request fields

  • Name
    connectorName
    Type
    string
    Description
  • Name
    apiKey
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connector
    Type
    BeehiivConnectorDto
    Description
  • Name
    message
    Type
    string
    Description

autessa.beehiiv.connectors.deleteMUTATE

autessa.beehiiv.connectors.delete({ connectorId })

Permanently delete a beehiiv connector and its stored credential.

Removes the beehiiv connector for connectorId, revoking every tool and script that relied on it. The stored credential is destroyed and cannot be recovered — reconnecting requires the full auth flow again. Requires WRITE (owner-level) access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    message
    Type
    string
    Description

autessa.beehiiv.connectors.getREAD

autessa.beehiiv.connectors.get({ connectorId })

Fetch one beehiiv connector by id.

Returns the full beehiiv connector for connectorId, including its sharing/active state and the linked account metadata — but never the stored credential. Fails if you lack READ access to the connector.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connector
    Type
    BeehiivConnectorDto
    Description

autessa.beehiiv.connectors.testConnectionMUTATE

autessa.beehiiv.connectors.testConnection({ apiKey })

Check whether a beehiiv API key is valid before saving it.

Validates the given API key by asking beehiiv to list its publications. Returns connectionSuccessful and, when valid, the publications the key can access — useful to confirm the key before connectors.create. Does not persist anything.

Request fields

  • Name
    apiKey
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connectionSuccessful
    Type
    boolean
    Description
  • Name
    message
    Type
    string
    Description
  • Name
    publications
    Type
    BeehiivPublication[]
    Description

autessa.beehiiv.connectors.updateMUTATE

autessa.beehiiv.connectors.update({ connectorId, connectorName, apiKey })

Rename a beehiiv connector or rotate its API key.

Applies a sparse patch to the beehiiv connector: send connectorName to rename it, or apiKey to replace the stored key (omit apiKey to keep the existing one). Omit a field to leave it unchanged. Requires WRITE access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.
  • Name
    connectorName
    Type
    string
    Description
  • Name
    apiKey
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connector
    Type
    BeehiivConnectorDto
    Description
  • Name
    message
    Type
    string
    Description