Skip to content

Workflows and services

Every workflow in an enabled provider repository is ignored until you whitelist it. A whitelisted workflow becomes a service once you give it a service description.

  1. Go to Provider → Workflows and select an enabled repository. Workflows from the default branch are listed. Use the branch selector to see other branches; in the branch view, workflows are listed by file name. Any workflow can be whitelisted, whatever triggers it.
  2. Turn on the toggle next to the workflow (Add to whitelist). You’ll see Workflow whitelisted, and a Whitelisted badge appears. On a non-default branch, it reads Enabled on <branch>.
  3. A whitelisted workflow without a service shows Link to Service. Use it, or continue below.
  1. Go to Provider → Service Descriptions. On the Provider Services sub-tab (the default), choose Create New.
  2. Choose the repository, then the branch and the whitelisted workflow. Only whitelisted workflows can have service descriptions.
  3. Fill in the fields (see below), then choose Save Service Description.
FieldWhat it’s for
Zekt Alias → Provider Display NameOptional. Shown in the Directory instead of the repository name. The service itself is shown under the workflow’s name.
Dispatch Event TypeThe event-type your Zekt Action sends, and that consumers listen for. Letters, numbers and hyphens, up to 50 characters.
Orchestration IdentifierThe slug used in orchestration plans. Lowercase kebab-case, 2–64 characters. It can’t be changed once set.
Supports OrchestrationDeclares that the service is meant to be orchestrated. It’s a declaration, not a gate: an undeclared service can still be orchestrated, and the requester gets a warning.
Service DescriptionWhat the service does, for people browsing the Directory.
Service TagsHelp people find the service.
Service AvatarJPG, PNG or WebP, up to 2 MB.
Publish to DirectoryOff: unlisted. On: choose Organization (the default) or Public. See Publish to the Directory.
Enable Self-triggerSee Self-trigger below.
Require Shield (Strict Mode)Payloads must be encrypted with Zekt Shield. Requires Shield on the repository.

Other buttons: Delete Service Description and Clear Form.

With Enable Self-trigger on, the service’s own repository also receives the service’s events, as if it had subscribed. Zekt creates this self-subscription automatically, with no approval needed. Use it to hand work from one workflow to another in the same repository, with delivery tracking.

  • To prevent loops, an event is re-dispatched to the same repository at most once.
  • Self-trigger deliveries are badged Self.
  • It isn’t a normal subscription: you can’t unsubscribe or revoke it. Turn the toggle off instead.
  • You can’t unwhitelist a workflow that has subscribers (Cannot Unwhitelist Workflow). Revoke their access first.
  • You can’t delete a provider service that still has active subscribers. Revoke them first.