Web Service Method: Create a New Webhook Configuration

Description

This call creates a new webhook configuration.

URL: /PoolParty/api/notifications/{project}/settings/create/webhook

Request

Supported Methods

POST

Content-Type

application/x-www-form-urlencoded

Request Parameters

Parameter

Type

Required

Description

interval

NotificationInterval

IMMEDIATELY | QUARTERLY | HOURLY | DAILY

name

String

smcApiConfig

IRI

trigger

Array of NotificationTrigger

Example Call
{
  "name" : "some name",
  "smcApiConfig" : {
    "uri" : "https://semantic-web.com/api/smcApiConfig#20283"
  },
  "interval" : "QUARTERLY",
  "trigger" : [ "CONCEPT_BLACKLIST_REMOVE", "WORKFLOW_STATE_CHANGE" ]
}

Response

Content-Type: application/json

Response Attributes

Common base response defining the minimum result structure and semantics.

Attribute

Type

Comment

PP_CUSTOM_MIME_TYPE_PP

String

PP_CUSTOM_MIME_TYPE_PREFIX

String

PP_CUSTOM_MIME_TYPE_SUFFIX

String

message

String

short descriptive message of the operation result, or an error description

result

Object

the actual response content body, defined by the resultType.

resultType

String

MIME type of the result if successful, or Exception type if an error occurred

status

int

indicates the success or error of the HTTP request, on the protocol layer

success

boolean

true if the operation was successful, on the application layer

Example Response
{
  "PP_CUSTOM_MIME_TYPE_PP" : "some PP_CUSTOM_MIME_TYPE_PP",
  "result" : { },
  "PP_CUSTOM_MIME_TYPE_PREFIX" : "some PP_CUSTOM_MIME_TYPE_PREFIX",
  "success" : false,
  "message" : "some message",
  "resultType" : "some resultType",
  "PP_CUSTOM_MIME_TYPE_SUFFIX" : "some PP_CUSTOM_MIME_TYPE_SUFFIX",
  "status" : 6311
}