Webhooks

List Webhooks

Required scopes: project.webhook (Read only).

get/projects/{projectId}/webhooks

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Query parameters

limitinteger

A maximum number of items to retrieve

offsetinteger

A starting offset in the collection

Response

Webhooks list

Example response

{
  "data": [
    {
      "data": {
        "id": 4,
        "projectId": 2,
        "name": "Proofread",
        "url": "https://webhook.site/1c20d9b5-6e6a-4522-974d-9da7ea7595c9",
        "events": [
          "file.approved"
        ],
        "payload": {
          "string.added": {
            "event": "{{event}}",
            "string": {
              "id": "{{stringId}}",
              "identifier": "{{stringIdentifier}}",
              "key": "{{stringKey}}",
              "text": "{{stringText}}",
              "type": "{{stringType}}",
              "context": "{{stringContext}}",
              "maxLength": "{{stringMaxLength}}",
              "isHidden": "{{stringIsHidden}}",
              "isDuplicate": "{{stringIsDuplicate}}",
              "masterStringId": "{{stringMasterStringId}}",
              "revision": "{{stringRevision}}",
              "hasPlurals": "{{stringHasPlurals}}",
              "plurals": "{{stringPlurals}}",
              "labelIds": "{{stringLabelIds}}",
              "url": "{{stringUrl}}",
              "createdAt": "{{stringCreatedAt}}",
              "updatedAt": "{{stringUpdatedAt}}",
              "file": {
                "id": "{{fileId}}",
                "name": "{{fileName}}",
                "title": "{{fileTitle}}",
                "type": "{{fileType}}",
                "path": "{{filePath}}",
                "status": "{{fileStatus}}",
                "revision": "{{fileRevision}}",
                "branchId": "{{branchId}}",
                "branchName": "{{branchName}}",
                "directoryId": "{{directoryId}}"
              },
              "project": {
                "id": "{{projectId}}",
                "userId": "{{projectUserId}}",
                "sourceLanguageId": "{{projectSourceLanguageId}}",
                "targetLanguageIds": "{{projectTargetLanguageIds}}",
                "identifier": "{{projectIdentifier}}",
                "name": "{{projectName}}",
                "createdAt": "{{projectCreatedAt}}",
                "updatedAt": "{{projectUpdatedAt}}",
                "lastActivity": "{{projectLastActivity}}",
                "description": "{{projectDescription}}",
                "url": "{{projectUrl}}",
                "cname": "{{projectCname}}",
                "logo": "{{projectLogo}}"
              }
            },
            "user": {
              "id": "{{userId}}",
              "username": "{{userUsername}}",
              "fullName": "{{userFullName}}",
              "avatarUrl": "{{userAvatarUrl}}"
            }
          }
        },
        "isActive": true,
        "batchingEnabled": true,
        "requestType": "GET",
        "contentType": "application/json",
        "createdAt": "2019-09-23T09:19:07+00:00",
        "updatedAt": "2019-09-23T09:19:07+00:00"
      }
    }
  ],
  "pagination": {
    "limit": 25
  }
}

Changes

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