CRcrowdin
Organization Webhooks

Add Webhook

Required scopes: webhook (Read and Write).

post/webhooks

Request

Request body

namestring required

Webhook name

urlstring required

Webhook URL

eventsEvents[] required

Webhook events

requestType'POST' | 'GET' required

Webhook request type

isActiveboolean

Defines whether webhook is active

batchingEnabledboolean

Defines whether webhook batching is enabled

contentType'multipart/form-data' | 'application/json' | 'application/x-www-form-urlencoded'

Webhook content type

headersobject

Webhook headers

Example request

{
  "name": "Proofread",
  "url": "https://webhook.site/1c20d9b5-6e6a-4522-974d-9da7ea7595c9",
  "events": [
    "project.created"
  ],
  "requestType": "POST",
  "batchingEnabled": true,
  "headers": {
    "Accept": "application/xml"
  },
  "payload": {
    "project.created": {
      "event": "{{event}}",
      "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": "{{creatorId}}",
        "username": "{{creatorUsername}}",
        "fullName": "{{creatorFullName}}",
        "avatarUrl": "{{creatorAvatarUrl}}"
      }
    }
  }
}

Response

Webhook was successfully added

Example response

{
  "data": {
    "id": 4,
    "name": "Proofread",
    "url": "https://webhook.site/1c20d9b5-6e6a-4522-974d-9da7ea7595c9",
    "events": [
      "project.created"
    ],
    "payload": {
      "project.created": {
        "event": "{{event}}",
        "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": "{{creatorId}}",
          "username": "{{creatorUsername}}",
          "fullName": "{{creatorFullName}}",
          "avatarUrl": "{{creatorAvatarUrl}}"
        }
      }
    },
    "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"
  }
}

Changes

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