> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# antonioned/discord

Create and send custom notifications and messages to Discord for CircleCI job statuses. This orb uses the certified slack orb as a base with commands changed for usage in Discord. View the orb's source: https://github.com/antonioned/circleci-discord-orb 


## Commands

### status

Send a status alert at the end of a job based on success or failure. Must be the last step in a job.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `webhook` | string | ${DISCORD_WEBHOOK_URL} | Enter either your Webhook value or use the CircleCI UI to add your token under the 'DISCORD_WEBHOOK' env var
 |
| `success_message` | string | :tada: A $CIRCLE_JOB job has succeeded! | Enter custom message. |
| `failure_message` | string | :red_circle: A $CIRCLE_JOB job has failed! | Enter custom message. |
| `success_only` | boolean | false | If `true`, notifications of failed jobs will not be sent.
 |
| `fail_only` | boolean | false | If `true`, notifications of successful jobs will not be sent.   
 |
| `mentions` | string |  | A comma separated list of user IDs. No spaces.   
 |
| `only_for_branches` | string |  | If set, a comma-separated list of branches for which to send notifications. No spaces.
 |
| `channel` | string |  | ID of channel if set, overrides webhook's default channel setting
 |

### approval

Send a notification that a manual approval job is ready

| Parameter | Type | Default | Description |
|---|---|---|---|
| `channel` | string |  | ID of channel if set, overrides webhook's default channel setting
 |
| `color` | string | 3843043 | Decimal color value for notification attachment color. |
| `mentions` | string |  | A comma separated list of user IDs. No spaces. |
| `message` | string | A workflow in CircleCI is awaiting your approval. | Enter custom message. |
| `url` | string | https://circleci.com/workflow-run/${CIRCLE_WORKFLOW_ID} | The URL to link back to. |
| `webhook` | string | ${DISCORD_WEBHOOK_URL} | Enter either your Webhook value or use the CircleCI UI to add your token under the 'DISCORD_WEBHOOK_URL' env var |