|
| 1 | +--- |
| 2 | +name: ory-contribute-integration |
| 3 | +description: Author a new Ory Network integration as a contribution to the public ory/integrates repository. Use when the user wants to contribute an integration back to Ory, add an entry to the Ory integrations registry/catalog, open a PR against ory/integrates, or publish a reusable integration for others — phrases like "contribute an Ory integration", "add my integration to ory/integrates", "submit a webhook integration to Ory", "get my integration into the registry". For wiring an integration into your own app instead, use ory-build-integration. |
| 4 | +--- |
| 5 | + |
| 6 | +# Contribute an Integration to ory/integrates |
| 7 | + |
| 8 | +You are helping the user author a new integration and contribute it back to the |
| 9 | +public `ory/integrates` repository ("Sample code and reference configuration for |
| 10 | +integrating Ory Network with third-party products"). The deliverable is a pull |
| 11 | +request against `github.com/ory/integrates`. |
| 12 | + |
| 13 | +This skill carries the workflow. The **template files** live in the repo itself — |
| 14 | +fetch them from `github.com/ory/integrates` (branch `main`) rather than |
| 15 | +reproducing them, so they never drift. |
| 16 | + |
| 17 | +> **Precondition:** `ory/integrates` must be reachable (it is a public repo). If |
| 18 | +> `gh repo view ory/integrates` or a fetch of a template file fails, tell the |
| 19 | +> user the repo is unreachable and stop — do not fabricate template contents. |
| 20 | +
|
| 21 | +## Step 0 — Open the "New integration" issue first |
| 22 | + |
| 23 | +Ory asks contributors to open a **New integration** issue before the PR, so scope |
| 24 | +is confirmed and the work isn't already in flight. Remind the user to do this |
| 25 | +(GitHub → `ory/integrates` → Issues → "New integration" template) and capture the |
| 26 | +issue number for the PR. |
| 27 | + |
| 28 | +## Step 1 — Get a checkout and pick the category |
| 29 | + |
| 30 | +The contribution workflow happens inside a checkout of the repo: |
| 31 | + |
| 32 | +```bash |
| 33 | +gh repo clone ory/integrates |
| 34 | +cd integrates |
| 35 | +``` |
| 36 | + |
| 37 | +(or a fork, if the user will PR from their own remote.) Then choose the |
| 38 | +**category folder** the integration belongs in — it must match an existing |
| 39 | +top-level directory (`crm/`, `api-gateways/`, `identity-verification/`, `mfa/`, |
| 40 | +`enterprise-sso/`, …). List them with `ls -d */ | grep -v _examples`. |
| 41 | + |
| 42 | +## Step 2 — Determine the integration type |
| 43 | + |
| 44 | +Every integration is one of three types. Infer from intent; if unclear, ask |
| 45 | +directly. |
| 46 | + |
| 47 | +| Signal from the user | Type | Template | |
| 48 | +|---|---|---| |
| 49 | +| Transform/enrich an identity at registration; gate or react to a self-service flow **synchronously**; call a vendor API during an Ory flow | `webhook` | `_examples/_template-webhook/` | |
| 50 | +| Validate Ory JWTs at a gateway; **Console-only** setup; no handler code | `config` | `_examples/_template-config/` | |
| 51 | +| React to events **asynchronously**; Ory Network **Enterprise** Live Event Stream consumer | `http-event` | `_examples/_template-http-event/` | |
| 52 | + |
| 53 | +## Step 3 — Copy the template into the category folder |
| 54 | + |
| 55 | +From the repo root, copy the whole template directory to |
| 56 | +`<category>/<integration-slug>` (slug is lowercase, hyphenated, matches the dir |
| 57 | +name): |
| 58 | + |
| 59 | +```bash |
| 60 | +cp -R _examples/_template-webhook crm/<integration-slug> # webhook |
| 61 | +# or _examples/_template-config / _examples/_template-http-event |
| 62 | +``` |
| 63 | + |
| 64 | +Each template ships these files (confirm with `ls -R <category>/<integration-slug>`): |
| 65 | + |
| 66 | +- **webhook** — `README.md`, `ory-actions.yaml`, `jsonnet/identity.jsonnet`, |
| 67 | + `registry.entry.yaml.example`, and a runnable `webhook/` (`server.ts`, |
| 68 | + `package.json`, `package-lock.json`, `tsconfig.json`, `.env.example`). |
| 69 | +- **config** — `README.md`, `ory-console-steps.md`, |
| 70 | + `registry.entry.yaml.example`. |
| 71 | +- **http-event** — `README.md`, `ory-event-stream.yaml`, |
| 72 | + `registry.entry.yaml.example`, and a runnable `webhook/` (`server.ts`, |
| 73 | + `idempotency.ts`, `package.json`, `package-lock.json`, `tsconfig.json`, |
| 74 | + `.env.example`). |
| 75 | + |
| 76 | +The copied files are the source of truth — read them and fill in every |
| 77 | +`<placeholder>` and `<!-- comment -->`. |
| 78 | + |
| 79 | +## Step 4 — Fill out the integration |
| 80 | + |
| 81 | +1. **README.md** — replace `<Integration Name>`, set the `Maintained by:` line |
| 82 | + (`Ory Engineering`, `Community contributors`, or the user's `@handle`), and |
| 83 | + complete: what it does, use case, prerequisites, deploy steps, **Ory Console |
| 84 | + configuration**, troubleshooting. No vendor marketing — factual wiring only. |
| 85 | +2. **Code / config for the type** (see per-type notes below). |
| 86 | +3. **registry.entry.yaml** — rename `registry.entry.yaml.example` → |
| 87 | + `registry.entry.yaml` and fill in every field (`name`, `displayName`, |
| 88 | + `vendor`, `category`, `type`, `maintainedBy`, `description`, `useCase`, |
| 89 | + `coreFunctionality`, `oryMechanism`, `protocol`, `status`; http-event also |
| 90 | + needs `subscribedEvents`). The field comments in the file enumerate the |
| 91 | + allowed enum values. |
| 92 | +4. **Apache-2.0 SPDX header** at the top of every source file you ship, e.g. |
| 93 | + `// SPDX-License-Identifier: Apache-2.0`. |
| 94 | + |
| 95 | +### webhook specifics |
| 96 | +- `ory-actions.yaml` is the Ory Action hook config (a `web_hook` with an |
| 97 | + `X-Webhook-Secret` `api_key` auth header). Point `url` at the deployed handler |
| 98 | + and set the shared secret. |
| 99 | +- `jsonnet/identity.jsonnet` is the request-body template — adjust to the shape |
| 100 | + your handler expects. |
| 101 | +- The `webhook/` server must run (`cd webhook && cp .env.example .env && npm |
| 102 | + install && npm start`); it exposes `GET /health` and the `POST` target. |
| 103 | + `ORY_WEBHOOK_SECRET` in `.env` must match the secret in `ory-actions.yaml`. |
| 104 | + |
| 105 | +### config specifics |
| 106 | +- No code. Write a real `ory-console-steps.md`: vendor-side setup, the exact Ory |
| 107 | + Console navigation, the fields to configure, a test, and troubleshooting. A |
| 108 | + README-only contribution with no real console steps will be rejected. |
| 109 | + |
| 110 | +### http-event specifics |
| 111 | +- `ory-event-stream.yaml` configures the Ory-side event target (URL with embedded |
| 112 | + Basic Auth) and the event filter. List the consumed events under both the YAML |
| 113 | + `events:` and the registry `subscribedEvents:`. |
| 114 | +- The `webhook/` handler authenticates with HTTP Basic Auth, dedupes by SHA-256 |
| 115 | + of the body (`idempotency.ts`) because delivery is at-least-once, and always |
| 116 | + returns 200. Live event streams are an **Enterprise** feature — say so in the |
| 117 | + README. |
| 118 | + |
| 119 | +## Step 5 — Regenerate the registry |
| 120 | + |
| 121 | +From the repo root: |
| 122 | + |
| 123 | +```bash |
| 124 | +cd scripts && npm install && cd .. |
| 125 | +node scripts/build-registry.js |
| 126 | +``` |
| 127 | + |
| 128 | +This rewrites the top-level `registry.yaml` from every `registry.entry.yaml`. |
| 129 | +Commit the regenerated `registry.yaml` along with your integration. |
| 130 | + |
| 131 | +## Step 6 — Open the PR (DCO + checklist) |
| 132 | + |
| 133 | +Walk the CONTRIBUTING checklist before opening the PR: |
| 134 | + |
| 135 | +- [ ] Integration is in the correct category folder. |
| 136 | +- [ ] `README.md` covers what it does, prerequisites, deploy, Console config, |
| 137 | + troubleshooting, and a `Maintained by:` line. |
| 138 | +- [ ] Type deliverables present: webhook → `ory-actions.yaml` + `jsonnet/` + |
| 139 | + runnable `webhook/`; config → real `ory-console-steps.md`; http-event → |
| 140 | + `ory-event-stream.yaml` + runnable `webhook/` + `subscribedEvents`. |
| 141 | +- [ ] `registry.entry.yaml` filled and `registry.yaml` regenerated. |
| 142 | +- [ ] Apache-2.0 SPDX header in each source file. |
| 143 | +- [ ] **DCO sign-off on every commit** — `git commit -s`. |
| 144 | + |
| 145 | +```bash |
| 146 | +git checkout -b add-<integration-slug>-integration |
| 147 | +git add <category>/<integration-slug> registry.yaml |
| 148 | +git commit -s -m "Add <Integration Name> integration" |
| 149 | +git push -u origin add-<integration-slug>-integration |
| 150 | +gh pr create --repo ory/integrates --title "Add <Integration Name> integration" \ |
| 151 | + --body "Closes #<issue-number>. <summary>" |
| 152 | +``` |
| 153 | + |
| 154 | +Expect review questions about Ory Network compatibility, webhook security |
| 155 | +(signature verification, secret handling), and README clarity. |
| 156 | + |
| 157 | +## What this skill does NOT do |
| 158 | + |
| 159 | +- It does not wire an integration into the user's own application — use |
| 160 | + `ory-build-integration` for that (no registry/DCO). |
| 161 | +- It does not run `build-registry.js` or open the PR without confirmation; it |
| 162 | + guides, the user executes. |
| 163 | +- It does not invent template contents — it reads the real files from |
| 164 | + `ory/integrates`. |
0 commit comments