Hooks Overview

Use stack hooks to automate builds on Cycle directly from your CI/CD workflow.

Hooks are used to automate stack builds. Hooks can be a generic endpoint you hit with some data, or can be configured as an integration. Cycle supports directly integrating with Gitlab repos, with more integrations in the works.

How Hooks Work

Hooks are associated with a stack. A stack can have multiple hooks added to it, each one corresponding to a "label". For example, a hook may have the label "dev". Any time the endpoint for this hook is hit, it triggers a stack rebuild. The label attached to the hook is applied to the build, for identification.

Each hook automatically creates different endpoints for our supported integrations. Currently, Cycle hooks can be configured as generic (i.e. your own custom solution may hit that endpoint), or as a Gitlab endpoint that can be plugged in directly, with other integrations coming.

Access Controls

Hooks can be scoped to prevent unauthorized access, or completely disabled. You can restrict access to the hook by setting a list of "authorized IPs", such as a VPN IP address.

Getting a Hook Endpoint

You can find the endpoint associated with your hook by following these steps:

  1. Click the Stacks tab on the navigation menu to the left.
  2. Locate the stack the hook is associated with on the list, and click the name.
  3. Click the "Hooks" tab at the top of the page.
  4. Locate the hook you wish to use on the list and click the name
  5. Select the hook type from the dropdown and copy the URL using the blue copy icon on the right side of the input field.

Need Help?

If you've got questions about the platform or need some help getting started, our team is more than happy to assist. Whether you're new to containers or just new to Cycle, reach out to us via livechat by clicking the blue circle in the bottom right corner. Join our Slack channel, and get help from the dev team or other members of the community, and check out our Roadmap to see what's planned for the future!