BEbeyondwords
SubscriberAuthentication

Configure the Piano subscriber auth integration

Changed on

Creates or updates the Piano subscriber auth integration for a project.

put/projects/{project_id}/integrations/subscriber_authentication/piano

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects/{project_id}/integrations/subscriber_authentication/piano
  • Auth
    API key in header X-Api-Key

Request body

aidstring
region'us' | 'eu' | 'au' | 'ap' | 'sandbox'

Region of the publisher's Piano dashboard. Defaults to us.

api_tokenstring

Piano application API token, from the Piano dashboard home page. Write-only - never returned by this API.

private_keystring

Piano application private key, used to verify the __tac access cookie. Write-only - never returned by this API.

Response

keeps the stored credentials when omitted

type'ghost' | 'piano'

The subscriber auth adapter type.

site_urlstring nullable

Ghost site URL (only present for the ghost type).

aidstring nullable

Piano application ID (only present for the piano type).

region'us' | 'eu' | 'au' | 'ap' | 'sandbox' | 'null' nullable

Piano dashboard region (only present for the piano type). Blank means us.

createdstring date-time

Time at which the object was created (ISO 8601)

updatedstring date-time

Time at which the object was updated (ISO 8601)

Changes