### Push Event Notification

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Usage example for sending notifications on repository push events.

```APIDOC
## Push Event Notification

### Description
Sends notifications when code is pushed to a repository, including commit information and branch details.

### Request Example
```yaml
- name: Send Telegram Notification
  uses: proDreams/actions-telegram-notifier@main
  with:
    token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
    chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
    status: ${{ job.status }}
    title: "Build Complete"
    notify_fields: "actor,repository,workflow,branch,commit"
    message: "The build process has finished."
    footer: "CI Pipeline v2.0"
```
```

--------------------------------

### Manual Pending Status Notification

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Example of manually setting the status to 'pending' for a long-running process. This allows for proactive notifications about the start of a workflow.

```yaml
# Example with manual pending status at start of workflow:
name: Long Running Process

on:
  push:

jobs:
  process:
    runs-on: ubuntu-latest

    steps:
      - name: Notify Start
        uses: proDreams/actions-telegram-notifier@main
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          status: "pending"
          title: "Build Started"
          notify_fields: "actor,repository,branch"
          message: "Long running process initiated..."

      - name: Run long process
        run: sleep 300 && ./heavy-task.sh

      - name: Notify Complete
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          status: ${{ job.status }}
          title: "Build Complete"
          notify_fields: "actor,repository,branch,commit"
```

--------------------------------

### Full Notification Example for Push Event

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Use this snippet to send a comprehensive notification including actor, repository, workflow, branch, commit, and repository tag details for a push event. Ensure TELEGRAM_BOT_TOKEN and TELEGRAM_CHAT_ID secrets are configured.

```yaml
name: Full Notification Example

on:
  push:
    branches: [main]

jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
      - name: Full Field Notification
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          status: ${{ job.status }}
          notify_fields: "actor,repository,workflow,branch,commit,repo_with_tag"
          message: "All fields example"
```

--------------------------------

### Send Workflow Dispatch Notification

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Set up notifications for manually triggered workflow runs. This example sends a message when a workflow is dispatched, including custom input parameters.

```yaml
name: Manual Deploy

on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Target environment'
        required: true
        default: 'staging'
        type: choice
        options:
          - staging
          - production
      version:
        description: 'Version to deploy'
        required: false
      skip_tests:
        description: 'Skip test suite'
        required: false
        type: boolean

jobs:
  deploy-notify:
    runs-on: ubuntu-latest

    steps:
      - name: Deploy application
        run: ./deploy.sh ${{ inputs.environment }} ${{ inputs.version }}

      - name: Send Dispatch Notification
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          status: ${{ job.status }}
          notify_fields: "actor,repository,workflow,branch,commit"
          title: "Manual Deployment Triggered"
          message: "Deployment initiated by operator"
          footer: "DevOps Pipeline"
```

--------------------------------

### Pull Request Event Notification

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Usage example for sending notifications on pull request events.

```APIDOC
## Pull Request Event Notification

### Description
Handles notifications for pull request events including opened, closed, edited, synchronized, and reopened actions.

### Request Example
```yaml
- name: Send PR Notification
  uses: proDreams/actions-telegram-notifier@main
  with:
    token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
    chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
    thread_id: ${{ secrets.TELEGRAM_THREAD_ID }}
    status: ${{ job.status }}
    notify_fields: "actor,repository,workflow"
    message: "Please review the changes"
    footer: "Review Team Notification"
```
```

--------------------------------

### Send Notification to a Specific Telegram Topic/Thread

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Send notifications to a specific topic within a Telegram supergroup by providing both `chat_id` and `thread_id`. This example demonstrates sending a message to a supergroup topic. Requires `TELEGRAM_BOT_TOKEN` and `TELEGRAM_CHAT_ID` secrets.

```yaml
# Example with supergroup topic:
name: Topic Notification

on:
  push:

jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
      - name: Send to Specific Topic
        uses: proDreams/actions-telegram-notifier@main
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: "-1001234567890"              # Supergroup ID
          thread_id: "42"                         # Topic/Thread ID
          status: ${{ job.status }}
          notify_fields: "actor,repository,workflow"
          message: "Notification sent to specific topic"
```

--------------------------------

### Action Configuration Inputs

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Defines the configuration parameters for the action. Required parameters include the Telegram bot token and chat ID. Optional parameters allow customization of message content, status indicators, and metadata fields.

```yaml
inputs:
  token:
    description: "Telegram Bot Token"
    required: true
  chat_id:
    description: "Chat ID to send the notification"
    required: true
  api_url:
    description: "Custom bot API URL"
    required: false
  thread_id:
    description: "Thread ID (optional)"
    required: false
  status:
    description: "Status of the workflow (e.g., success, failure)"
    required: false
  title:
    description: "Title text"
    required: false
  message:
    description: "Message text"
    required: false
  footer:
    description: "Footer text"
    required: false
  proxy_url:
    description: "Proxy server URL for routing requests (e.g., http://user:pass@127.0.0.1:8080 or socks5://ip:port)"
    required: false
  notify_fields:
    description: "Additional fields"
    required: false
```

--------------------------------

### GitHub Action Configuration

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Configuration parameters for the Actions Telegram Notify GitHub Action, defined within the workflow 'with' block.

```APIDOC
## GitHub Action Configuration

### Description
Defines the required and optional inputs for the Actions Telegram Notify action.

### Parameters
#### Request Body (Workflow Inputs)
- **token** (string) - Required - Telegram Bot Token
- **chat_id** (string) - Required - Chat ID to send the notification
- **api_url** (string) - Optional - Custom bot API URL
- **thread_id** (string) - Optional - Thread ID for supergroup topics
- **status** (string) - Optional - Status of the workflow (e.g., success, failure)
- **title** (string) - Optional - Title text
- **message** (string) - Optional - Message text
- **footer** (string) - Optional - Footer text
- **proxy_url** (string) - Optional - Proxy server URL for routing requests
- **notify_fields** (string) - Optional - Additional fields to include in the notification
```

--------------------------------

### Notify via Proxy Server for Restricted Networks

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Utilize a proxy server for network access by specifying the `proxy_url`. Supports HTTP and SOCKS5 proxies, with or without authentication. Ensure `TELEGRAM_BOT_TOKEN` and `TELEGRAM_CHAT_ID` secrets are set.

```yaml
# Using proxy for restricted networks
      - name: Notify via Proxy
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          proxy_url: ${{ secrets.PROXY_URL }}  # http://user:pass@proxy:8080 or socks5://proxy:1080
          status: ${{ job.status }}
          notify_fields: "actor,repository,workflow"
```

--------------------------------

### Push Event Notification Workflow

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Configures a GitHub Actions workflow to send Telegram notifications on push events. It checks out code, builds the project, runs tests, and then sends a notification using the Telegram notifier action. The `if: always()` ensures the notification is sent regardless of job status.

```yaml
name: CI Push Notification

on:
  push:
    branches: [main, develop]

jobs:
  build-and-notify:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Build project
        run: npm run build

      - name: Run tests
        run: npm test

      - name: Send Telegram Notification
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          status: ${{ job.status }}
          title: "Build Complete"
          notify_fields: "actor,repository,workflow,branch,commit"
          message: "The build process has finished."
          footer: "CI Pipeline v2.0"
```

--------------------------------

### Configure Telegram Notifications for Pull Request Review Events

Source: https://github.com/prodreams/actions-telegram-notifier/blob/main/README.MD

Use this configuration to trigger notifications when a pull request review is submitted.

```yaml
name: CI

on:
  pull_request_review:
    types:
      - submitted

jobs:
  notify:
    runs-on: ubuntu-latest

    steps:
      - name: Run Actions Telegram Notify
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          status: ${{ job.status }}
          notify_fields: "actor,repository,workflow"
```

--------------------------------

### Configure Telegram Notifier for Push Event

Source: https://github.com/prodreams/actions-telegram-notifier/blob/main/README.MD

Use this configuration in your GitHub Actions workflow to send Telegram notifications for push events. Ensure your Telegram Bot Token and Chat ID are stored securely as GitHub Secrets.

```yaml
name: CI

on:
  push:

jobs:
  notify:
    runs-on: ubuntu-latest

    steps:
      - name: Run Actions Telegram Notify
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          status: ${{ job.status }}
          notify_fields: "actor,repository,workflow,branch,commit"
          message: "Test message."
          footer: "Test footer"
```

--------------------------------

### Notify via Custom Telegram Bot API Server

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Configure a custom Telegram Bot API server URL using the `api_url` parameter. This is useful for environments with restricted network access or when using self-hosted API instances. Requires `TELEGRAM_BOT_TOKEN` and `TELEGRAM_CHAT_ID` secrets.

```yaml
name: Deploy with Custom Network Config

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Deploy
        run: ./deploy.sh

      # Using custom Telegram Bot API server
      - name: Notify via Custom API
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          api_url: ${{ secrets.CUSTOM_TELEGRAM_API_URL }}  # e.g., https://telegram.corp.local
          status: ${{ job.status }}
          notify_fields: "actor,repository"
```

--------------------------------

### Configure Telegram Notifications for Pull Request Events

Source: https://github.com/prodreams/actions-telegram-notifier/blob/main/README.MD

Use this configuration to trigger notifications when a pull request is opened or closed.

```yaml
name: CI

on:
  pull_request:
    types:
      - closed
      - opened

jobs:
  notify:
    runs-on: ubuntu-latest

    steps:
      - name: Run Actions Telegram Notify
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          status: ${{ job.status }}
          notify_fields: "actor,repository,workflow"
```

--------------------------------

### Configure Telegram Notifications for Workflow Dispatch Events

Source: https://github.com/prodreams/actions-telegram-notifier/blob/main/README.MD

Use this configuration to trigger notifications for manually dispatched workflows, including support for custom inputs.

```yaml
name: CI

on:
  workflow_dispatch:
    inputs:
      custom_input:
        description: 'Custom Input'
        required: false

jobs:
  notify:
    runs-on: ubuntu-latest

    steps:
      - name: Run Actions Telegram Notify
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          status: ${{ job.status }}
          notify_fields: "actor,repository,workflow"
```

--------------------------------

### Pull Request Event Notification Workflow

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Sets up a GitHub Actions workflow to send Telegram notifications for pull request events. It uses the Telegram notifier action to send messages for PRs that are opened, closed, reopened, or synchronized. The `thread_id` can be used for supergroup topics.

```yaml
name: Pull Request Notification

on:
  pull_request:
    types: [opened, closed, reopened, synchronize]

jobs:
  pr-notify:
    runs-on: ubuntu-latest

    steps:
      - name: Send PR Notification
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          thread_id: ${{ secrets.TELEGRAM_THREAD_ID }}  # For supergroup topics
          status: ${{ job.status }}
          notify_fields: "actor,repository,workflow"
          message: "Please review the changes"
          footer: "Review Team Notification"
```

--------------------------------

### Send PR Review Notification

Source: https://context7.com/prodreams/actions-telegram-notifier/llms.txt

Configure notifications for pull request review events. This snippet sends a message when a review is submitted, including details about the review state and reviewer.

```yaml
name: PR Review Notification

on:
  pull_request_review:
    types: [submitted]

jobs:
  review-notify:
    runs-on: ubuntu-latest

    steps:
      - name: Send Review Notification
        uses: proDreams/actions-telegram-notifier@main
        if: always()
        with:
          token: ${{ secrets.TELEGRAM_BOT_TOKEN }}
          chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          status: ${{ job.status }}
          notify_fields: "actor,repository,workflow"
          message: "A review has been submitted"
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.