Adding WebHooks

/webhooks

Allows WUBS to add new webhooks for a partner.

URI is a required parameter and should be a valid formed URI starting with 'HTTPS'. 'isPrimary' is an optional parameter and can only have 'true' value.

Upon successful validation of parameters, a webhook will be assigned a unique ID (GUID like) which could be used later to update or delete a webhook.

{
"uri": <endpoint>,
"isPrimary": true
}             

201 Created
{
"id":"<Id of a webhook>"
}

400 Bad Request
- When validation fails

>/webhooks/id}

Allows update to URL value of a webhook. Allows to set IsPrimary value to true for a webhook which is not primary.

'isPrimary' is optional parameter and can only have 'true' value. 'uri' field is optional, and if it has a value, it will follow the validation rules for "Adding webhooks".

{
"uri": <endpoint>,
"isPrimary": true
}

200 OK

400 Bad Request - When validation fails

/webhooks/{id}

{
}

204 No Content

400 Bad Request
 - When validation fails

/webhooks/{id}

Allows retrieval of a webhook currently configured for a partner.

{
}

200 OK
 { 
"id":"<Id of a webhook>"
"uri":"<webhook URL>",
"isPrimary":<true/false>,"createdOn":
"<timestamp when webhook was created>",
"lastUpdatedOn":"<timestamp when webhook was last updated>",
"lastEvent":
{
"pushedOn": "<timestamp when event was pushed>",
"eventType": "<one of the defined event types>",
"status":"<one of "Successful/Failed">"
}
}

404 Not Found
 - if the partner currently has no webhook configured

/webhooks

{
}

200 OK
{
webhooks": 
[
{ 
"id": "<Id of a webhook>"
"uri":"<webhook URL>",
"isPrimary":<true/false>,
"createdOn":"<timestamp when webhook was created>",
"lastUpdatedOn":"<timestamp when webhook was last updated>",
"lastEvent": 
{
"pushedOn":"<timestamp when event was pushed>",
"eventType": "<one of the defined event types>",
"status": "<one of "Successful/Failed">"
}
}
]
}

404 Not Found
 - if the partner currently has no webhooks configured