Sign in
Internal

Receive a Hey API webhook

post/v1/internal/webhooks/hey-api

Request

  • Base URL: https://api.heyapi.dev (the document declares no server; this is the origin it was published from)
  • URL: https://api.heyapi.dev/v1/internal/webhooks/hey-api
  • Auth: HTTP bearer

Request body

idstring uuid required
object'event' required
timestampnumber required
type'specification.created' | 'specification.deleted' required

Example request

{
  "data": {
    "actor": "mrlubos",
    "actor_id": "12529395",
    "api_key_id": "e4ce4324-1177-47ca-aeef-b1d011bd3932",
    "branch": "feat/awesome-feature",
    "branch_base": "main",
    "ci_platform": "github",
    "commit_sha": "1c6945d83eab3580791eb4148562b3bd2e16df14",
    "created_at": "2025-02-21T02:37:15.840Z",
    "creator_user_id": "5d2827a4-b3fc-4946-bb3b-72f23e89c6aa",
    "event_name": "push",
    "id": "e4ce4324-1177-47ca-aeef-b1d011bd3932",
    "job": "ci",
    "project_id": "e4ce4324-1177-47ca-aeef-b1d011bd3932",
    "ref": "refs/heads/main",
    "ref_type": "branch",
    "repository": "hey-api/platform",
    "run_id": "13448896305",
    "run_number": "1",
    "tags": [
      "dev"
    ],
    "updated_at": "2025-02-21T02:37:15.840Z",
    "version": "1.0.0",
    "workflow": "CI"
  },
  "id": "e4ce4324-1177-47ca-aeef-b1d011bd3932"
}

Response

OK

messagestring required

Example response

{
  "message": "OK"
}

Changes

No recorded changes to this operation across all 1 revision of this API.