This is a Crank Cog for Marketo, providing steps and assertions for you to validate the state and behavior of your Marketo instance.
Ensure you have the crank CLI and docker installed and running locally,
then run the following. You'll be prompted to enter your Marketo credentials
once the Cog is successfully installed.
$ crank cog:install stackmoxie/marketo
Note: You can always re-authenticate later.
You will be asked for the following authentication details on installation. To avoid prompts in a CI/CD context, you can provide the same details as environment variables.
| Field | Install-Time Environment Variable | Description |
|---|---|---|
| endpoint | CRANK_AUTOMATONINC_MARKETO__ENDPOINT |
REST API endpoint (without /rest), e.g. https://123-abc-456.mktorest.com |
| clientId | CRANK_AUTOMATONINC_MARKETO__CLIENTID |
Client ID |
| clientSecret | CRANK_AUTOMATONINC_MARKETO__CLIENTSECRET |
Client Secret |
# Re-authenticate by running this
$ crank cog:auth stackmoxie/marketo
| Name (ID) | Expression | Expected Data |
|---|---|---|
| Check a Marketo Lead's Activity ( CheckLeadActivityStep) |
there should be an? (?<activityTypeIdOrName>.+) activity for marketo lead (?<email>.+) in the last (?<minutes>\d+) minutes? |
- email: The email address of the Marketo Lead - activityTypeIdOrName: The activity type ID (number) or name - minutes: The number of minutes prior to now to use when filtering the activity feed - withAttributes: Represents additional parameters that should be used to validate an activity. The key in the object represents an attribute name and the value represents the expected value - partitionId: ID of partition lead belongs to |
| Create or Update a Marketo Custom Object ( CreateOrUpdateCustomObjectStep) |
create or update an? (?<name>.+) marketo custom object linked to lead (?<linkValue>.+) |
- name: Custom Object's API name - linkValue: Linked Lead's email address - customObject: Map of custom object data whose keys are field names. - partitionId: ID of partition lead belongs to |
| Delete a Marketo Custom Object ( DeleteCustomObjectStep) |
delete the (?<name>.+) marketo custom object linked to lead (?<linkValue>.+) |
- name: Custom Object's API name - linkValue: Linked Lead's email address - dedupeFields: Map of custom dedupeFields data whose keys are field names. - partitionId: ID of partition lead belongs to |
| Check a field on a Marketo Custom Object ( CustomObjectFieldEqualsStep) |
the (?<field>[a-zA-Z0-9_-]+) field on the (?<name>.+) marketo custom object linked to lead (?<linkValue>.+) should (?<operator>be set|not be set|be less than|be greater than|be one of|be|contain|not be one of|not be|not contain) ?(?<expectedValue>.+)? |
- name: Custom Object's API name - linkValue: Linked Lead's email address - field: Field name to check - operator: Check Logic (be, not be, contain, not contain, be greater than, be less than, be set, not be set, be one of, or not be one of) - expectedValue: The expected value of the field - dedupeFields: Map of custom dedupeFields data whose keys are field names. - partitionId: ID of partition lead belongs to |
| Create or update a Marketo Lead ( CreateOrUpdateLeadByFieldStep) |
create or update a marketo lead |
- lead: A map of field names to field values |
| Delete a Marketo Lead ( DeleteLeadStep) |
delete the (?<email>.+) marketo lead |
- email: Lead's email address - partitionId: ID of partition lead belongs to |
| Check a field on a Marketo Lead ( LeadFieldEqualsStep) |
the (?<field>[a-zA-Z0-9_-]+) field on marketo lead (?<email>.+) should (?<operator>be set|not be set|be less than|be greater than|be one of|be|contain|not be one of|not be|not contain) ?(?<expectation>.+)? |
- email: Lead's email address - field: Field name to check - operator: Check Logic (be, not be, contain, not contain, be greater than, be less than, be set, not be set, be one of, or not be one of) - expectation: Expected field value - partitionId: ID of partition lead belongs to |
| Add Marketo Lead to Smart Campaign ( AddLeadToSmartCampaignStep) |
add the (?<email>.+) marketo lead to smart campaign (?<campaign>.+) |
- email: Lead's email address - campaign: Smart campaign name or numeric id - partitionId: ID of partition lead belongs to |
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to add or update tests as appropriate.
- Install node.js (v12.x+ recommended)
- Clone this repository.
- Install dependencies via
npm install - Run
npm startto validate the cog works locally (ctrl+cto kill it) - Run
crank cog:install --source=local --local-start-command="npm start"to register your local instance of this cog. You may need to append a--forceflag or runcrank cog:uninstall stackmoxie/marketoif you've already installed the distributed version of this cog.
Modify code in src/steps and validate your changes by running
crank cog:step stackmoxie/marketo and selecting your step.
To add new steps, create new step classes in src/steps. Use existing steps as
a starting point for your new step(s). Note that you will need to run
crank registry:rebuild in order for your new steps to be recognized.
Always add tests for your steps in the test/steps folder. Use existing tests
as a guide.
Modify the ClientWrapper class at src/client/client-wrapper.ts.
- If you need to add or modify authentication details, see the
expectedAuthFieldsstatic property. - If you need to expose additional logic from the wrapped API client, add a new ublic method to the wrapper class, which can then be called in any step.
- It's also possible to swap out the wrapped API client completely. You should only have to modify code within this clase to achieve that.
Note that you will need to run crank registry:rebuild in order for any
changes to authentication fields to be reflected. Afterward, you can
re-authenticate this cog by running crank cog:auth stackmoxie/marketo
Tests can be found in the test directory and run like this: npm test.
Ensure your code meets standards by running npm run lint.