GET/desk/api/v2/webhooks/{id}.json

Get a single webhook by id.

Path Params

Name
id
Type
integer
required
Description

Responses

Code
200
Type
object
Schema
Description
200 OK
WebhookAPIBody handles the get/create/update request/response for webhook.
Code
400
Type
object
Schema
Description
400 Bad Request
Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

Examples

200 OK

WebhookAPIBody

{
  "included": {
    "users": [
      {
        "autoFollowOnCC": true,
        "avatarURL": "string",
        "createdAt": "2024-07-26T20:26:26.473Z",
        "createdBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "deletedAt": "2024-07-26T20:26:26.473Z",
        "deletedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "editMethod": "string",
        "email": "string",
        "filter_args": {
          "aggregate": {
            "Distinct": true,
            "Field": "string",
            "Operation": "string"
          },
          "bulkDryExecute": true,
          "fields": [
            "string"
          ],
          "filter": [
            "string"
          ],
          "id": 0,
          "ids": [
            0
          ],
          "includes": [
            "string"
          ],
          "orderBy": "string",
          "orderMode": "asc",
          "page": 0,
          "pageOffset": 0,
          "pageSize": 0,
          "skipAggregation": true
        },
        "firstName": "string",
        "id": 0,
        "isAppOwner": true,
        "isPartTime": true,
        "lastName": "string",
        "ldKey": "string",
        "onboarding": {
          "addedFirstInbox": true,
          "bookmarkPage": true,
          "checkDeskHelpSite": true,
          "checkSampleInbox": true,
          "dismissedWelcome": true,
          "exploreHelpsites": true,
          "exploreReports": true,
          "inviteTeam": true,
          "repliedToFirstTicket": true,
          "reviewedCompanySettings": true,
          "reviewedProfile": true
        },
        "projectsCompanyId": 0,
        "reviewer": true,
        "role": "string",
        "sendPushNotifications": true,
        "sendWebNotifications": true,
        "state": "string",
        "ticketReplyRedirect": "string",
        "timeFormatId": 0,
        "timezoneId": 0,
        "trainingWheelsEnrollment": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        },
        "updatedAt": "2024-07-26T20:26:26.473Z",
        "updatedBy": {
          "delete": true,
          "id": 0,
          "meta": {},
          "type": 0
        }
      }
    ]
  },
  "webhook": {
    "createdAt": "2024-07-26T20:26:26.473Z",
    "createdBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    },
    "deletedAt": "2024-07-26T20:26:26.473Z",
    "deletedBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    },
    "failures": 0,
    "filter_args": {
      "aggregate": {
        "Distinct": true,
        "Field": "string",
        "Operation": "string"
      },
      "bulkDryExecute": true,
      "fields": [
        "string"
      ],
      "filter": [
        "string"
      ],
      "id": 0,
      "ids": [
        0
      ],
      "includes": [
        "string"
      ],
      "orderBy": "string",
      "orderMode": "asc",
      "page": 0,
      "pageOffset": 0,
      "pageSize": 0,
      "skipAggregation": true
    },
    "id": 0,
    "requestBody": "string",
    "requestError": "string",
    "requestHeaders": "string",
    "responseBody": "string",
    "responseHeaders": "string",
    "responseStatus": 0,
    "state": "string",
    "updatedAt": "2024-07-26T20:26:26.473Z",
    "updatedBy": {
      "delete": true,
      "id": 0,
      "meta": {},
      "type": 0
    },
    "uuid": "string",
    "webhookEndpointId": 0,
    "webhookEventCode": "string"
  }
}

Download Swagger