Service level URL template parameters

The Oracle Eloqua app Developer Framework supports URL Templating, enabling the configuration of service URIs Eloqua calls out to. Any acceptable template parameter is substituted with the appropriate value before the call is made. See the Introduction to URL templating for more information.

There are different template parameters available for different calls in different AppCloud service types:

To look up individual parameters, please see the below parameter descriptions.

Service parameters

Action services

URL Available parameters Conditional Parameters
Create URL

{InstanceId}, {InstallId}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}, {EntityType}, {CustomObjectId}

 
Configure URL

{InstanceId}, {InstallId}, {AssetType}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}, {EntityType}, {CustomObjectId}

{AssetId} and {AssetName} are available only if the campaign has been saved with the referencing asset.
Copy URL {InstanceId}, {InstallId},{AssetId}, {AssetName}, {AssetType}, {OriginalInstanceId}, {OriginalInstallId}, {OriginalAssetId}, {OriginalAssetName}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}
Notification URL

{InstanceId}, {InstallId},{AssetId}, {AssetName}, {AssetType}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}, {ExecutionId}, {EntityType}, {CustomObjectId}

 
Delete URL {InstanceId}, {InstallId}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}

Decision services

URL Available parameters Conditional Parameters
Create URL

{InstanceId}, {InstallId}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}, {EntityType}, {CustomObjectId}

 
Configure URL

{InstanceId}, {InstallId}, {AssetType}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}, {EntityType}, {CustomObjectId}

{AssetId} and {AssetName} are available only if the campaign has been saved with the referencing asset.
Copy URL {InstanceId}, {InstallId},{AssetId}, {AssetName}, {AssetType}, {OriginalInstanceId}, {OriginalInstallId}, {OriginalAssetId}, {OriginalAssetName}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}  
Notification URL

{InstanceId}, {InstallId},{AssetId}, {AssetName}, {AssetType}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}, {ExecutionId}, {EntityType}, {CustomObjectId}

 
Delete URL {InstanceId}, {InstallId}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}  

Feeder services

URL Available parameters Conditional Parameters
Create URL

{InstanceId}, {InstallId}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}, {EntityType}, {CustomObjectId}

 
Configure URL

{InstanceId}, {InstallId}, {AssetType}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}, {EntityType}, {CustomObjectId}

{AssetId} and {AssetName} are available only if the campaign has been saved with the referencing asset.
Copy URL {InstanceId}, {InstallId},{AssetId}, {AssetName}, {AssetType}, {OriginalInstanceId}, {OriginalInstallId}, {OriginalAssetId}, {OriginalAssetName}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}  
Notification URL

{InstanceId}, {InstallId},{AssetId}, {AssetName}, {AssetType}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {EventType}, {SiteId}, {AppId}, {EntityType}, {CustomObjectId}

 
Delete URL {InstanceId}, {InstallId}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}  

Content services

URL Available parameters Conditional Parameters
Create URL {InstanceId}, {InstallId}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}  
Configure URL {InstanceId}, {InstallId}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId} {AssetId}, {AssetType} and {AssetName} are available only if the email or landing page has been saved with the referencing asset.
Copy URL {InstanceId}, {InstallId},{AssetId}, {AssetName}, {AssetType}, {OriginalInstanceId}, {OriginalInstallId}, {OriginalAssetId}, {OriginalAssetName}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}  
Email Notification URL {InstanceId}, {InstallId},{AssetId}, {AssetName}, {AssetType}, {UserName}, {UserId}, {SiteName}, {SiteId}, {AppId}, {RenderType}, {IsPreview}, {ExecutionId}  
Landing Page Notification URL {InstanceId}, {InstallId},{AssetId}, {AssetName}, {AssetType}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId} ,{VisitorId}  
Delete URL {InstanceId}, {InstallId}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}  

Menu services

URL Available parameters
Action URL {InstallId}, {AssetId}, {AssetName}, {AssetType}, {AssetPath}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}

Firehose services

URL Available parameters
Notification URL {InstallId},{AssetId}, {AssetName}, {assetType}, {UserName}, {UserId}, {UserCulture}, {SiteName}, {SiteId}, {AppId}, {EventType}

Parameter descriptions

  • InstanceId is a templated parameter used in AppCloud service apps. Its value is the GUID for the specific instance of the AppCloud service being used. For instance, when a user drags and drops an action or decision service onto a campaign canvas this is considered a distinct instance and a new InstanceId is created.

  • InstallId is a templated parameter used in AppCloud service apps. Its value is the GUID for the user's installation of the AppCloud App. Whenever a user installs an app, a new InstallId is created.

  • AssetId is a templated parameter used in AppCloud service apps. Its value is the referencing asset's ID. Each instance of an asset will have a unique AssetId.

  • AssetName is a templated parameter used in AppCloud service apps. Its value is the referencing asset's filename.

  • AssetType is a templated parameter used in AppCloud service apps. Its value is the referencing asset's type. Possible asset types include campaign, form, landing page, program, etc.

  • AssetPath is a templated parameter used in AppCloud service apps. Its value is the referencing asset's directory path.

  • OriginalInstanceId is a templated parameter used in AppCloud service apps. It is specific to a service's Copy URL and its value is the original service's InstanceId (as opposed to the copied service's InstanceId).

  • OriginalInstallId is a templated parameter used in AppCloud service apps. It is specific to a service's Copy URL and its value is the original service's installId (as opposed to the copied service's InstallId).

  • OriginalAssetId is a templated parameter used in AppCloud service apps. It is specific to a service's Copy URL and its value is the original service's AssetId (as opposed to the copied service's AssetId).

  • OriginalAssetName is a templated parameter used in AppCloud service apps. It is specific to a service's Copy URL and its value is the original service's AssetName (as opposed to the copied service's AssetName).

  • UserName is a templated parameter used in AppCloud service apps. Its value is the name of the user who triggered the call.

  • UserId is a templated parameter used in AppCloud service apps. Its value is the ID of the user who triggered the call.

  • UserCulture is a templated parameter used in AppCloud service apps. Its value is the linguistic profile of the user of the user that triggered the call. Eloqua uses Microsoft's CultureInfo class to define culture. For example, for English (United States), the code is "en-US", for French (Canada) it is "fr-CA".

  • SiteName is a templated parameter used in AppCloud service apps. Its value is the name of the user's Eloqua instance.

  • SiteId is a templated parameter used in AppCloud service apps. Its value is the GUID-based ID for the user's Eloqua instance.

  • AppId is a templated parameter used in AppCloud service apps. Its value is the GUID-based ID of the app making the service call. Each AppCloud app has a single unique AppId.

  • EventType is a templated parameter used in AppCloud service apps. Its value is the status change that triggered the call (Created, Activated, Draft, etc.)

    List of EventType values: Created, Updated, Deleted, Activated, ActivatedBySchedule, Scheduled, Draft, DraftWaitingApproval, DraftApproved, CampaignAssetAdded, CampaignAssetRemoved, CampaignLandingPageAdded, CampaignLandingPageRemoved, CampaignFormAdded, CampaignFormRemoved, CampaignEmailAdded, CampaignEmailRemoved, CampaignSegmentAdded, CampaignSegmentRemoved, MembersAdded, ContentRequired, Completed.

  • VisitorId is a templated parameter used in AppCloud content service apps. Its value is an integer and represents the ID of the visitor for whom you wish to construct a landing page.

  • RenderType is a templated parameter used in AppCloud content service apps. Its value specifies the different types of email renderings. Possible values are:

    • 0: No render -- no content is being assembled.
    • 1: EmailSend -- content is being assembled for sending an email.
    • 2: LiveWeb -- content is being assembled to render a live landing page.
    • 3: EmailPreview -- content is being assembled to render an email preview.
    • 4: WebPreview -- content is being assembled to render a preview of a landing page.
    • 5: EmailSaved -- content is being assembled to render the web version of a sent email.

  • IsPreview is a templated parameter used in AppCloud content service apps. Its value specifies whether the referencing email is in preview mode. Possible values are:

    • 0: False
    • 1: True

  • ExecutionId is a templated parameter used in AppCloud content service apps. Its value is an integer and identifies a unique email send execution.

  • EntityType is a templated parameter used in AppCloud service apps. The value specifies the entity type the campaign or program is set to. Possible values are Contacts or CustomObjectRecords.

    For instance, if a user drags a decision step onto a custom object program, the EntityType would be CustomObjectRecords because the program's entity type is set to custom objects. Alternatively, if that decision step was dragged onto a contact program, the EntityType would be Contacts.

    Note that campaigns only support the contact entity type, but programs can support contacts or custom objects. Use the AssetType parameter to determine if the asset is a campaign or a program.

  • CustomObjectId is a templated parameter used in AppCloud action, decision, and feeder service apps for programs. Its value is the ID of the custom object associated with the program when CustomObjectRecords is specified for EntityType. It must be an integer.