Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Deskcrew Io Webhooks API
version: 1.0.0
contact:
name: DeskCrew support
url: https://deskcrew.io/board/deskcrew
email: hello@deskcrew.io
description: 'Operations tagged Webhooks across 2 of this provider''s published API definitions: openapi.json, deskcrew-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://deskcrew.io
security:
- bearerAuth: []
tags:
- name: Webhooks
paths:
/api/v1/webhooks:
get:
summary: List webhook endpoints
description: Requires the `webhooks:manage` scope.
operationId: get_api_v1_webhooks
security:
- bearerAuth: []
responses:
'200':
description: Success
'401':
description: Missing or invalid API key
'403':
description: The key does not hold the required scope
'404':
description: Not found in this workspace
'429':
description: Rate limited
tags:
- Webhooks
post:
summary: Register a webhook endpoint
description: The URL must be public https. Private, loopback, link-local and metadata addresses are rejected at write time and again at send time. Requires the `webhooks:manage` scope.
operationId: post_api_v1_webhooks
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
description: 'url: string, required, https; events: string[], required'
responses:
'200':
description: Success
'401':
description: Missing or invalid API key
'403':
description: The key does not hold the required scope
'404':
description: Not found in this workspace
'429':
description: Rate limited
tags:
- Webhooks
servers:
- url: https://deskcrew.io
/api/v1/webhooks/{id}:
delete:
summary: Delete a webhook endpoint
description: Requires the `webhooks:manage` scope.
operationId: delete_api_v1_webhooks__id_
security:
- bearerAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
'401':
description: Missing or invalid API key
'403':
description: The key does not hold the required scope
'404':
description: Not found in this workspace
'429':
description: Rate limited
tags:
- Webhooks
servers:
- url: https://deskcrew.io
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: A workspace API key that starts with dk_, or a signed-in person's session token from the DeskCrew apps.
x-refined-from:
- openapi.json
- deskcrew-io-openapi.json
x-scopes:
- tickets:read
- tickets:write
- tickets:reply
- issues:read
- issues:write
- changelog:read
- changelog:write
- customers:read
- kb:read
- kb:write
- webhooks:manage
- errors:write
- bounties:manage
- bounties:read