Get

GET
/workspaces
/:domain
/webhooks
/:webhook_id

Shows details of the specified webhook. Restricted to admins only.

Request

REQUIRED SCOPES

WORKSPACE, WEBHOOK_INFO

URL PARAMETERS

domainrequired string

The workspace domain.

webhook_idrequired integer

The numerical ID of the desired webhook.

Last modified on Sep 23, 2024

Create List

Example:

CURL
curl -X GET "https://api.buddy.works/workspaces/:domain/webhooks/:webhook_id" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/webhooks/1",
  "html_url": "https://app.buddy.works/buddy/webhook/1",
  "id": 1,
  "target_url": "http://test.buddy.works/auth/",
  "secret_key": "023bd610-7738-47a5-b0c4-5e887431ffcf",
  "projects": [
    16,
    22
  ],
  "events": [
    "EXECUTION_FINISHED",
    "PUSH"
  ],
  "requests": [
    {
      "post_date": "2016-03-02T11:32:58Z",
      "response_status": 200,
      "body": "{\"workspace\":{\"url\":\"https://api.buddy.works/workspaces/buddy\",\"html_url\":\"https://app.buddy.works/buddy\",\"id\":1,\"name\":\"buddy\",\"domain\":\"buddy\"},\"invoker\":{\"url\":\"https://app.buddy.works/buddy/member/1\",\"html_url\":\"https://app.buddy.works/buddy/profile/1\",\"id\":1,\"name\":\"Mike Benson\",\"avatar_url\":\"https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png\",\"title\":\"Creative director\",\"email\":\"mike@buddy.works\"},\"project\":{\"url\":\"https://api.buddy.works/projects/company-website\",\"html_url\":\"https://app.buddy.works/buddy/company-website\",\"name\":\"company-website\",\"display_name\":\"Company Website\",\"status\":\"ACTIVE\"},\"current_date\":\"2016-03-02T11:32:58.604Z\",\"execution\":{\"url\":\"https://api.buddy.works/projects/company-website/pipelines/2/executions/1\",\"html_url\":\"https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/execution/56d6cf6599f1e1114ef10774\",\"id\":1,\"start_date\":\"2016-03-02T11:32:53.355Z\",\"finish_date\":\"2016-03-02T11:32:58.576Z\",\"mode\":\"MANUAL\",\"refresh\":false,\"status\":\"SUCCESSFUL\",\"comment\":\"\",\"branch\":\"master\",\"creator\":{\"url\":\"https://app.buddy.works/buddy/member/1\",\"html_url\":\"https://app.buddy.works/buddy/profile/1\",\"id\":1,\"name\":\"Mike Benson\",\"avatar_url\":\"https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png\",\"title\":\"Creative director\",\"email\":\"mike@buddy.works\"},\"pipeline\":{\"url\":\"https://api.buddy.works/projects/company-website/pipelines/2\",\"html_url\":\"https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/execution/56d6cf6599f1e1114ef10774\",\"id\":2,\"name\":\"Live mirror\",\"ref_name\":\"master\"},\"action_executions\":[{\"to_revision\":\"506a3963507943d6908154f4bc9646e829128a08\",\"status\":\"SUCCESSFUL\",\"progress\":100.0,\"action\":{\"url\":\"https://api.buddy.works/projects/company-website/pipelines/2/actions/5\",\"html_url\":\"https://app.buddy.works/buddy/company-website/pipelines/action/5/edit\",\"id\":5,\"name\":\"Upload files to Live mirror\",\"type\":\"FTP\",\"trigger_time\":\"ON_EVERY_EXECUTION\",\"run_only_on_first_failure\":false,\"status\":\"SUCCESSFUL\",\"revision\":null}}]}}"
    }
  ]
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999