webhook
Create, list, update, delete and test webhooks with hotcodepush webhook, in raw, Slack, Discord or Teams format and filtered by event and app.
hotcodepush webhook manages an organization's webhooks: subscriptions to audit events, posted to one URL in the raw, slack, discord or teams format.
A webhook is named with --webhook <id|name>. Owners and Admins manage them on a plan that includes webhooks.
create
Create a webhook that posts the events it subscribes to, in one format, to one URL. For the raw format the signing secret is printed once.
| Option | Type | Description |
|---|---|---|
--app <id|name> | string | The app, by id or name, whose events alone the webhook receives. Defaults to every app's and the organization's events, never to hotcodepush.json's app. |
--event <type> | string, repeatable | An event type the webhook receives, such as release.created, repeatable. |
--format <format> | raw | slack | discord | teams | raw for HotCodePush's signed JSON, slack, discord or teams for a message to that service's incoming-webhook URL. |
--name <name> | string | The name, unique in the organization. |
--url <url> | string | The https URL the events are posted to. |
hotcodepush webhook create --name releases --url https://example.com/hooks/hotcodepush --format raw --event release.created --event release.paused
hotcodepush webhook create --name team-chat --url https://chat.example.com/incoming/team --format slack --event release.failure_rate_exceeded --app "My App" --jsonget
Print a webhook with its format, URL, subscribed events, app filter and delivery health.
A webhook disabled after repeated failures, as Signature and retries describes, is enabled again with update --enabled.
| Option | Type | Description |
|---|---|---|
--webhook <id|name> | string | The webhook, by id or name. |
hotcodepush webhook get --webhook releases
hotcodepush webhook get --webhook 3c9e7a52-8d14-4b6f-a0e2-5f71c3d8b946 --jsonlist
List the organization's webhooks.
| Option | Type | Description |
|---|---|---|
--limit <count> | number | How many to list, at most 100; 50 by default. |
--offset <count> | number | How many to skip: the offset the previous page ended with. |
hotcodepush webhook list
hotcodepush webhook list --organization Acme --jsonupdate
Rename a webhook or change its URL, events, app filter or whether it is enabled. The format and the secret never change, and a flag left out is a field left out.
Passing --event replaces the subscribed events, so repeat it for every type the webhook keeps.
| Option | Type | Description |
|---|---|---|
--app <id|name> | string | The app, by id or name, whose events alone the webhook receives. Defaults to every app's and the organization's events, never to hotcodepush.json's app. |
--clear-app | boolean | Sets the app filter back to null: the webhook receives every app's events and the organization's. |
--enabled | boolean | Whether the webhook delivers. Turning it on again restarts the count of failures that disables it. Pass false to turn it off. |
--event <type> | string, repeatable | An event type the webhook receives, such as release.created, repeatable. |
--name <name> | string | The webhook's new name. |
--url <url> | string | The https URL the events are posted to. |
--webhook <id|name> | string | The webhook, by id or name. |
hotcodepush webhook update --webhook releases --event release.created --event release.revoked
hotcodepush webhook update --webhook team-chat --enabled --clear-app --jsondelete
Delete a webhook at once, with its delivery log.
Confirms once (--yes in a script).
| Option | Type | Description |
|---|---|---|
--webhook <id|name> | string | The webhook, by id or name. |
hotcodepush webhook delete --webhook releases
hotcodepush webhook delete --webhook team-chat --yes --jsontest
Send one sample event through the webhook's delivery path and print the receiver's answer.
Confirms once (--yes in a script).
The sample is a webhook.test event, so a receiver tells it from a real one.
| Option | Type | Description |
|---|---|---|
--webhook <id|name> | string | The webhook, by id or name. |
hotcodepush webhook test --webhook releases
hotcodepush webhook test --webhook team-chat --yes --jsonLast updated on