You can find the swagger below:
{
"swagger":"2.0",
"info":{
"version":"B2B_v1",
"title":"MyApp API B2B V1"
},
"host":"devapi.example.com",
"schemes":[
"https"
],
"paths":{
"/apiB2B/Hooks/Subscribe":{
"put":{
"tags":[
"HooksB2B"
],
"summary":"Subscribe to a webhook",
"description":"Subscribe to a webhook; if already existing update it",
"operationId":"HooksB2B_SubscribeHook",
"consumes":[
"application/json",
"text/json"
],
"produces":[
"application/json",
"text/json"
],
"parameters":[
{
"name":"model",
"in":"body",
"required":true,
"schema":{
"$ref":"#/definitions/SubscribeHookDTO"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/SubscribeHook"
}
}
},
"deprecated":false
}
},
"/apiB2B/Hooks/Unsubscribe":{
"delete":{
"tags":[
"HooksB2B"
],
"summary":"Unsubscribe from a webhook",
"description":"Unsubscribe from a webhook",
"operationId":"HooksB2B_UnsubscribeHook",
"consumes":[
"application/json",
"text/json"
],
"produces":[
"application/json",
"text/json"
],
"parameters":[
{
"name":"model",
"in":"body",
"required":true,
"schema":{
"$ref":"#/definitions/UnsubscribeHookDTO"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/Object"
}
}
},
"deprecated":false
}
},
"/apiB2B/Hooks/Test":{
"post":{
"tags":[
"HooksB2B"
],
"summary":"Send a test request to a WebHook",
"description":"Send a test request to a WebHook",
"operationId":"HooksB2B_TestHook",
"consumes":[
"application/json",
"text/json"
],
"produces":[
"application/json",
"text/json"
],
"parameters":[
{
"name":"model",
"in":"body",
"required":true,
"schema":{
"$ref":"#/definitions/TestHookDTO"
}
}
],
"responses":{
"200":{
"description":"OK",
"schema":{
"$ref":"#/definitions/Object"
}
}
},
"deprecated":false
}
}
},
"definitions":{"SubscribeHookDTO":{
"required":[
"target_url",
"event"
],
"type":"object",
"properties":{
"target_url":{
"description":"Webhook Target Endpoint",
"type":"string"
},
"event":{
"description":"Webhook Event Name\r\n document_accepted<br />\r\n document_uploaded<br />\r\n document_rejected<br />\r\n document_irrelevant<br />\r\n application_status_updated<br />\r\n application_created<br />\r\n document_comment<br /> \r\n application_note_created<br /> \r\n application_note_updated<br /> \r\n application_note_removed<br />",
"type":"string"
}
}
},
"SubscribeHook":{
"required":[
"hook_event"
],
"type":"object",
"properties":{
"hook_event":{
"type":"string"
}
}
},
"UnsubscribeHookDTO":{
"required":[
"hook_event"
],
"type":"object",
"properties":{
"hook_event":{
"description":"Webhook Event Name\r\n document_accepted<br />\r\n document_uploaded<br />\r\n document_rejected<br />\r\n document_irrelevant<br />\r\n application_status_updated<br />\r\n application_created<br />\r\n document_comment<br /> \r\n application_note_created<br /> \r\n application_note_updated<br /> \r\n application_note_removed<br />",
"type":"string"
}
}
},
"TestHookDTO":{
"required":[
"target_url",
"webhookKind"
],
"type":"object",
"properties":{
"target_url":{
"description":"Webhook Target Endpoint",
"type":"string"
},
"webhookKind":{
"description":"Webhook Event Name\r\n document_accepted<br />\r\n document_uploaded<br />\r\n document_rejected<br />\r\n document_irrelevant<br />\r\n application_status_updated<br />\r\n application_created<br />\r\n document_comment<br /> \r\n application_note_created<br /> \r\n application_note_updated<br /> \r\n application_note_removed<br />",
"type":"string"
}
}
}
}
}
