younifyd
Menu

marketingEvent

Fetch a single marketing event by its ID.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the marketingEvent action (under Marketing).
  3. Fill in the fields below, then reference the result from later steps as {{marketingevent.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
query MarketingEvent($id: ID!) {
  marketingEvent(id: $id) {
    app {
      apiKey
      appStoreAppUrl
      appStoreDeveloperUrl
      availableAccessScopes {
        description
        handle
      }
      banner {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      description
      developerName
      developerType
      developerUrl
      embedded
      failedRequirements {
        action
        message
      }
      features
      feedback {
        app
        channel
        feedbackGeneratedAt
        link
        messages
        state
      }
      handle
      icon {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      id
      installUrl
      installation {
        accessScopes
        activeSubscriptions
        app
        channel
        id
        launchUrl
        publication
        subscriptions
        uninstallUrl
      }
      isPostPurchaseAppInUse
      launchUrl
      navigationItems {
        id
        title
        url
      }
      optionalAccessScopes {
        description
        handle
      }
      previouslyInstalled
      pricingDetails
      pricingDetailsSummary
      privacyPolicyUrl
      publicCategory
      published
      requestedAccessScopes {
        description
        handle
      }
      screenshots {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      shopifyDeveloped
      title
      uninstallMessage
      uninstallUrl
      webhookApiVersion
    }
    channel
    channelHandle
    description
    endedAt
    id
    legacyResourceId
    manageUrl
    marketingChannelType
    previewUrl
    remoteId
    scheduledToEndAt
    sourceAndMedium
    startedAt
    targetTypeDisplayText
    type
    utmCampaign
    utmMedium
    utmSource
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The ID of the `MarketingEvent` to return.

json
{
  "id": "string"
}

Response

Read the result with {{marketingevent.response.data.data.marketingEvent}}. If the API returns errors, the step fails and they are at {{marketingevent.response.data.errors}}.

appobject
apiKeystring
appStoreAppUrlstring
appStoreDeveloperUrlstring
availableAccessScopesarray<object>
bannerobject7 fields
descriptionstring
developerNamestring
developerTypestring

One ofSHOPIFYPARTNERMERCHANTUNKNOWN

developerUrlstring
embeddedboolean
failedRequirementsarray<object>
featuresarray<object>
feedbackobject6 fields
handlestring
iconobject7 fields
idstring
installUrlstring
installationobject9 fields
isPostPurchaseAppInUseboolean
launchUrlstring
navigationItemsarray<object>
optionalAccessScopesarray<object>
previouslyInstalledboolean
pricingDetailsstring
pricingDetailsSummarystring
privacyPolicyUrlstring
publicCategorystring

One ofPRIVATEPUBLICCUSTOMOTHER

publishedboolean
requestedAccessScopesarray<object>
screenshotsarray<object>
shopifyDevelopedboolean
titlestring
uninstallMessagestring
uninstallUrlstring
webhookApiVersionstring
channelstring

One ofSEARCHDISPLAYSOCIALEMAILREFERRAL

channelHandlestring
descriptionstring
endedAtstring
idstring
legacyResourceIdstring
manageUrlstring
marketingChannelTypestring

One ofSEARCHDISPLAYSOCIALEMAILREFERRAL

previewUrlstring
remoteIdstring
scheduledToEndAtstring
sourceAndMediumstring
startedAtstring
targetTypeDisplayTextstring
typestring

One ofABANDONED_CARTADAFFILIATELINKLOYALTYMESSAGENEWSLETTERNOTIFICATIONPOSTRETARGETINGTRANSACTIONALSTOREFRONT_APPSEO

utmCampaignstring
utmMediumstring
utmSourcestring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?