List experiences you can invoke

client.Experiences.List(ctx) (*ExperienceListResponse, error)

GET/v3/experiences

The experiences enabled for your account, with the actions you may invoke on each and the fields each action accepts. Treat it as the list to build against: anything not described here is unsupported and may change or stop working without notice.

ReturnsExpand Collapse

type ExperienceListResponse struct{…}

Experiences []ExperienceListResponseExperienceOptional

Actions []ExperienceListResponseExperienceActionOptional

Fields map[string, ExperienceListResponseExperienceActionField]Optional

Fields you may send in params, keyed by the exact name to use.

Max int64Optional

Maximum length, for strings.

Required boolOptional

Type stringOptional

One of the following:

const ExperienceListResponseExperienceActionFieldTypeString ExperienceListResponseExperienceActionFieldType = "string"

const ExperienceListResponseExperienceActionFieldTypeCents ExperienceListResponseExperienceActionFieldType = "cents"

const ExperienceListResponseExperienceActionFieldTypeInt ExperienceListResponseExperienceActionFieldType = "int"

const ExperienceListResponseExperienceActionFieldTypeURL ExperienceListResponseExperienceActionFieldType = "url"

Name stringOptional

Summary stringOptional

DisplayName stringOptional

Experience stringOptional

List experiences you can invoke

package main

import (
  "context"
  "fmt"

  "github.com/linq-team/linq-go"
  "github.com/linq-team/linq-go/option"
)

func main() {
  client := linqgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  experiences, err := client.Experiences.List(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", experiences.Experiences)
}

{
  "experiences": [
    {
      "experience": "agentpay",
      "display_name": "Agent Pay",
      "actions": [
        {
          "name": "request_payment",
          "summary": "Ask the customer to pay a payment request.",
          "fields": {
            "checkout_url": {
              "type": "url",
              "required": true
            },
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            },
            "note": {
              "type": "string",
              "max": 120,
              "required": false
            }
          }
        }
      ]
    },
    {
      "experience": "agentcard",
      "display_name": "Agentcard",
      "actions": [
        {
          "name": "attach_card",
          "summary": "Ask the customer to add a card to their wallet.",
          "fields": {
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            },
            "subtitle": {
              "type": "string",
              "max": 120,
              "required": false
            },
            "button": {
              "type": "string",
              "max": 24,
              "required": false
            }
          }
        }
      ]
    },
    {
      "experience": "link",
      "display_name": "Link",
      "actions": [
        {
          "name": "open",
          "summary": "Ask the recipient to open a link.",
          "fields": {
            "url": {
              "type": "url",
              "max": 2048,
              "required": true
            },
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            }
          }
        }
      ]
    }
  ]
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}

Returns Examples

{
  "experiences": [
    {
      "experience": "agentpay",
      "display_name": "Agent Pay",
      "actions": [
        {
          "name": "request_payment",
          "summary": "Ask the customer to pay a payment request.",
          "fields": {
            "checkout_url": {
              "type": "url",
              "required": true
            },
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            },
            "note": {
              "type": "string",
              "max": 120,
              "required": false
            }
          }
        }
      ]
    },
    {
      "experience": "agentcard",
      "display_name": "Agentcard",
      "actions": [
        {
          "name": "attach_card",
          "summary": "Ask the customer to add a card to their wallet.",
          "fields": {
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            },
            "subtitle": {
              "type": "string",
              "max": 120,
              "required": false
            },
            "button": {
              "type": "string",
              "max": 24,
              "required": false
            }
          }
        }
      ]
    },
    {
      "experience": "link",
      "display_name": "Link",
      "actions": [
        {
          "name": "open",
          "summary": "Ask the recipient to open a link.",
          "fields": {
            "url": {
              "type": "url",
              "max": 2048,
              "required": true
            },
            "title": {
              "type": "string",
              "max": 64,
              "required": false
            }
          }
        }
      ]
    }
  ]
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}