Blockstream Enterprise
ReferenceAPI ReferenceCustomers

Magiclink Customers

Magiclink Customers.

Request

CustomersMagiclinkRequest
interface CustomersMagiclinkRequest {
  action: 'get'
  resource: '/customers/magiclink'
  details?: {} | undefined
}

Prop

Type

Response

CustomersMagiclinkResponse_success
interface CustomersMagiclinkResponse_success {
  status: 'success'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
  details: {
    svix_app_id: string | undefined
    svix_magic_link: string | undefined
  }
  metadata: unknown
}

Prop

Type

CustomersMagiclinkResponse_failed | pending | unauthorized | rejected
interface CustomersMagiclinkResponse_failed | pending | unauthorized | rejected {
  status: 'failed' | 'pending' | 'unauthorized' | 'rejected'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
}

Prop

Type

Example

Example
import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'

const response = await broadcastRequest<
  typeof resourceSchema.shape.customers.shape.magiclink
>(
  {
    action: 'get',
    resource: '/customers/magiclink',
    details: {
      // TODO: fill in required fields
    },
  },
  blockstream,
)

List Customers

List Customers.

Create Rules

Create Rules.

On this page

Request
Response
Example