DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Webhooks

Webhooks

List

List All the Organization level Webhooks that are defined.

HTTP REQUEST: GET

This API lists webhooks. With no parameters, it gets the org specific webhooks. Caller can append projectId or notificationType to search more specifically.

GET/api/1.0/org/{orgId}/webhooks
QUERY PARAMETERS
NameTypeDescription
projectIdstringThe Project Id to fetch webhooks for
notificationTypestringThe Notification Type
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
503This error will occur if Design Center APIs are not enabled.
200 Response Body
{
  "status": {
    "code": 200,
    "i18n_message": "response.ok",
    "message": "ok"
  },
  "response": {
    "id": "abc123"
  }
}

HTTP REQUEST: POST

This API creates a webhook. The body of the request is a JSON serialized form for the webhook.

POST/api/1.0/org/{orgId}/webhooks
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
503This error will occur if Design Center APIs are not enabled.
Request Body
{
  "org_id": "default",
  "notification_type": "SNAPSHOT",
  "url": "http://www.yahoo.com",
  "project_id": "ab7f99ac-cb3a-428b-6092-5cd1ba28abe7"
}
200 Response Body
{
  "status": {
    "code": 200,
    "i18n_message": "response.ok",
    "message": "ok"
  },
  "response": {
    "id": "abc123"
  },
  "time_to_process": "1.1 seconds"
}

Webhooks

HTTP REQUEST: GET 

GET/api/1.0/org/{orgId}/webhooks/{hookId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
hookIdstringThe Webhook ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
503This error will occur if Design Center APIs are not enabled.
200 Response Body
{
  "status": {
    "code": 200,
    "i18n_message": "response.ok",
    "message": "ok"
  },
  "response": {
    "id": "abc123"
  },
  "time_to_process": "1.1 seconds"
}

HTTP REQUEST: DELETE

Deletes the webhook identified by hookId in org identified by orgId.

DELETE/api/1.0/org/{orgId}/webhooks/{hookId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
hookIdstringThe Webhook ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if calling user does not have access right for the API.
500A server error occurred. Check the logs for more details.
503This error will occur if Design Center APIs are not enabled.
200 Response Body
{
  "status": {
    "code": 200,
    "i18n_message": "response.ok",
    "message": "ok"
  },
  "response": {
    "id": "abc123"
  },
  "time_to_process": "1.1 seconds"
}