Event Trigger Integration

Available under the Integration Family: Notifications

Event Trigger Integration is used to connect Shippable DevOps Assembly Lines platform so that you can

  • Create a daisy chain of projects, so that you can trigger one from another
  • Send a webhook to an external service with custom payloads

You can create this from the integrations page by following instructions here: Adding an account integration.

This is the information you would require to create this integration:

  • Name -- friendly name for the integration
  • Trigger endpoint -- Dropdown with following values
    • project -- used to trigger other CI projects on Shippable. (Deprecated feature - You can achieve this more easily with Assembly Lines)
      • Authorization -- Shippable API Token. Format apiToken ae45edaa-adfa-bgdf-ae45edaaae45
    • Generic Webhook -- used to send payload to external entities
      • WebhookURL -- endpoint to send payload to
      • Authorization -- Token based auth to the external URL

Resources that use this Integration

Resources are the building blocks of assembly lines and some types of resources refer to integrations by their names. The following resource types can be created with an Event Trigger integration.

Default Environment Variables

When you create a resource with this integration, and use it as an IN or OUT for a job that can execute user defined scripts, a set of environment variables are configured by the platform that may be useful to set the context before user defined scripts execute as part of the job. These variables are available when a resource with this integration type is used.

<NAME> is the the friendly name of the resource.

Environment variable Description
<NAME>_INTEGRATION_PROJECT Shippable Project ID, for project webhooks
<NAME>_INTEGRATION_WEBHOOKURL Webhook URL, it is available for Generic Webhooks only
<NAME>_INTEGRATION_AUTHORIZATION Authorization token that was set in the integration

Shippable Utility Functions

To make it easy to use these environment variables, the platform provides a command line utility that can be used to work with these values.

How to use these utility functions is documented here.

Further Reading