Returns a service definition for user install

Changed on Jan 25, 2022

get/getServiceDefinition

Request

The document declares no server URL.
Auth: one of:
- API key in header x-api-key
- OAuth 2 (authorization code, authorization URL https://www.example.com/authorize, token URL https://www.example.com/token; client credentials, token URL https://www.example.com/token)
- HTTP basic

Response

Service Install Metadata

apiNamestring required

Default identifier for service and activity. Users installing multiple service with the same apiName will be prompted to resolve collision by inputting a custom name during installation. Values 'success', 'reason', and 'errorCode' are always included in activityData and may not be declared here, see '#components/schemas/callbackData'.

caBundlestring uri

Location of CA bundle. Used if your service's SSL certificate chain is not know to Marketo API clients

primaryAttributestring required

API name of the attribute that describes the primary asset. This must match an attribute from the flow attribute list and cannot match an attribute from the callback attribute list.

Example response

{
  "apiName": "lookupTable",
  "i18n": {
    "en_US": {
      "name": "Lookup Table",
      "filterName": "Lookup Table was Used",
      "triggerName": "Use Lookup Table",
      "description": "Use a lookup table to get a value"
    }
  },
  "caBundle": "https://serviceprovider.com/get/caBundle",
  "invocationPayloadDef": {
    "globalAttributes": [
      {
        "apiName": "keyValue",
        "i18n": {
          "en_US": {
            "name": "Key Value",
            "description": "Marketo field to be used as lookup value",
            "uiTooltip": "What Marketo field should be used to find the lookup value?"
          }
        }
      }
    ],
    "flowAttributes": [
      {
        "apiName": "keyValue",
        "i18n": {
          "en_US": {
            "name": "Key Value",
            "description": "Marketo field to be used as lookup value",
            "uiTooltip": "What Marketo field should be used to find the lookup value?"
          }
        }
      }
    ],
    "fields": [
      {
        "serviceAttribute": "providerFieldName",
        "suggestedMarketoAttribute": "marketoAttributeName"
      }
    ],
    "headers": [
      {
        "name": "x-enable-extended-logging"
      }
    ],
    "myTokenContext": [
      "Event Date",
      "Event Address"
    ]
  },
  "callbackPayloadDef": {
    "attributes": [
      {
        "apiName": "keyValue",
        "i18n": {
          "en_US": {
            "name": "Key Value",
            "description": "Marketo field to be used as lookup value",
            "uiTooltip": "What Marketo field should be used to find the lookup value?"
          }
        }
      }
    ],
    "fields": [
      {
        "serviceAttribute": "providerFieldName",
        "suggestedMarketoAttribute": "marketoAttributeName"
      }
    ]
  }
}

Changes

Jan 25, 202223e8746a8ad6 Revision changes
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added to the // response property allOf list for the response status
- info
  added to the // response property allOf list for the response status
- info
  removed subschema #2 from the // response property allOf list for the response status
- info
  removed subschema #2 from the // response property allOf list for the response status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //////// became required for the status
- info
  the response property //////// became required for the status
- info
  the response property //////// became required for the status
Jan 25, 2022f5a6579617b8 Revision changes
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //////// became optional for the status
- breaking
  the response property //////// became optional for the status
- breaking
  the response property //////// became optional for the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added subschema #2 to the // response property allOf list for the response status
- info
  added subschema #2 to the // response property allOf list for the response status
- info
  removed from the // response property allOf list for the response status
- info
  removed from the // response property allOf list for the response status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history (13 revisions)