Deploy your applications on Dokploy with git commit information via Dokploy's webhook urls. The action collects metadata from the GitHub runner (ref, sha, repo, actor, and a commit message) and POSTs it to your Dokploy webhook.

{
  "ref": "<GITHUB_REF>",
  "head_commit": {
    "id": "<GITHUB_SHA>",
    "message": "<commit message>"
  },
  "repository": { "full_name": "<owner/repo>" },
  "pusher": { "name": "<actor>" }
}

The HTTP header X-GitHub-Event is included and reflects the current workflow event (e.g., push, workflow_dispatch, pull_request, …).

name: Deploy (push)
on:
  push:
    branches: [ main ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Dokploy Deployment
        uses: your-org/dokploy-deploy-action@v1
        with:
          webhook_url: ${{ secrets.DOKPLOY_WEBHOOK_URL }}

- name: Dokploy Deployment
  uses: TimLanzi/dokploy-deploy-action@v1
  with:
    webhook_url: ${{ secrets.DOKPLOY_WEBHOOK_URL }}
    commit_message: ${{ github.event.head_commit.message }} # for push

commit_message: ${{ github.event.pull_request.title }}

commit_message: "Manual deploy of ${{ github.sha }}"

- name: Dokploy Deployment
  id: dokploy
  uses: TimLanzi/dokploy-deploy-action@v1
  with:
    webhook_url: ${{ secrets.DOKPLOY_WEBHOOK_URL }}

- name: Show payload
  run: echo '${{ steps.dokploy.outputs.payload }}'

• Secrets: Store the webhook URL as a repository/organization secret (e.g., DOKPLOY_WEBHOOK_URL).

• Checkout: If you want the action to auto-detect the commit message, include actions/checkout@v4. Otherwise, pass commit_message.

• jq: The action checks for jq and attempts to install it on common runners (Ubuntu/macOS) and Alpine containers. If you prefer, you can remove that and install jq in the caller workflow instead.

push: Works out-of-the-box; you can use ${{ github.event.head_commit.message }} if desired.

pull_request: No head_commit in payload. Provide commit_message (e.g., PR title).

workflow_dispatch / schedule / others: Provide commit_message, or the action will try git log -1 if checkout is present.

HTTP 4xx/5xx: The step fails the job (uses --fail-with-body / --fail). Check the step logs for the server’s response body.

No commit message: Ensure actions/checkout ran, or pass commit_message.

jq not found: Either rely on the action’s installer (default) or install jq in the caller workflow:

- run: sudo apt-get update -y && sudo apt-get install -y jq