Organization Webhooks

Edit Webhook

Required scopes: webhook (Read and Write).

patch/webhooks/{organizationWebhookId}

Request

Path parameters

organizationWebhookIdinteger required

Webhook Identifier. Get via List Webhooks

Request body

op'replace' | 'test' required

Patch operation to perform

path'/name' | '/isActive' | '/batchingEnabled' | '/contentType' | '/events' | '/headers' | '/requestType' | '/payload' json-pointer required

A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>

Response

Webhook was successfully updated

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.