Skip to content
This repository has been archived by the owner on Sep 3, 2021. It is now read-only.

Latest commit

 

History

History
161 lines (98 loc) · 3.77 KB

WebhooksApi.md

File metadata and controls

161 lines (98 loc) · 3.77 KB

WebhooksApi

All URIs are relative to /api/v2

Method HTTP request Description
deleteWebhook DELETE /webhooks/{resourceId} Delete a webhook by ID.
getWebhook GET /webhooks/{resourceId} Get a webhook by ID.
getWebhooks GET /webhooks Fetch a list of all webhooks.
patchWebhook PATCH /webhooks/{resourceId} Modify a webhook by ID.
postWebhook POST /webhooks Create a webhook.

deleteWebhook

Delete a webhook by ID.

Example

 deleteWebhook resourceId=value

Parameters

Name Type Description Notes
resourceId string The resource ID.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getWebhook

Get a webhook by ID.

Example

 getWebhook resourceId=value

Parameters

Name Type Description Notes
resourceId string The resource ID.

Return type

Webhook

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getWebhooks

Fetch a list of all webhooks.

Example

 getWebhooks

Parameters

This endpoint does not need any parameter.

Return type

Webhooks

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchWebhook

Modify a webhook by ID.

Example

 patchWebhook resourceId=value

Parameters

Name Type Description Notes
resourceId string The resource ID.
patchDelta array[PatchOperation] Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'

Return type

Webhook

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postWebhook

Create a webhook.

Example

 postWebhook

Parameters

Name Type Description Notes
webhookBody WebhookBody New webhook.

Return type

Webhook

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]