Test Webhook
using RestSharp;
var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Webhook/TestWebhook");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"Webhook\": {\n \"WebhookId\": 123,\n \"Name\": \"<string>\",\n \"Events\": [\n \"<string>\"\n ],\n \"TargetUrl\": \"<string>\",\n \"Secret\": \"<string>\",\n \"Type\": \"<string>\",\n \"Headers\": {},\n \"Properties\": {},\n \"Registered\": \"2023-11-07T05:31:56Z\",\n \"RegisteredAssociate\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"PersonId\": 123,\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"GroupIdx\": 123,\n \"FullName\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"Deleted\": true,\n \"EjUserId\": 123,\n \"UserName\": \"<string>\",\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"Updated\": \"2023-11-07T05:31:56Z\",\n \"UpdatedAssociate\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"PersonId\": 123,\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"GroupIdx\": 123,\n \"FullName\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"Deleted\": true,\n \"EjUserId\": 123,\n \"UserName\": \"<string>\",\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"ErrorsEmail\": \"<string>\",\n \"ErrorEmails\": [\n \"<string>\"\n ],\n \"ErrorAssociates\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ChildItems\": \"<array>\",\n \"IconHint\": \"<string>\",\n \"ColorBlock\": 123,\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"Description\": \"<string>\",\n \"TotalCalls\": 123,\n \"TotalErrors\": 123,\n \"ConsecutiveErrors\": 123,\n \"LastError\": \"<string>\"\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Webhook: {
WebhookId: 123,
Name: '<string>',
Events: ['<string>'],
TargetUrl: '<string>',
Secret: '<string>',
Type: '<string>',
Headers: {},
Properties: {},
Registered: '2023-11-07T05:31:56Z',
RegisteredAssociate: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Updated: '2023-11-07T05:31:56Z',
UpdatedAssociate: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
ErrorsEmail: '<string>',
ErrorEmails: ['<string>'],
ErrorAssociates: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Description: '<string>',
TotalCalls: 123,
TotalErrors: 123,
ConsecutiveErrors: 123,
LastError: '<string>'
}
})
};
fetch('http://localhost:53294/api/v1/Agents/Webhook/TestWebhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "53294",
CURLOPT_URL => "http://localhost:53294/api/v1/Agents/Webhook/TestWebhook",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Webhook' => [
'WebhookId' => 123,
'Name' => '<string>',
'Events' => [
'<string>'
],
'TargetUrl' => '<string>',
'Secret' => '<string>',
'Type' => '<string>',
'Headers' => [
],
'Properties' => [
],
'Registered' => '2023-11-07T05:31:56Z',
'RegisteredAssociate' => [
'AssociateId' => 123,
'Name' => '<string>',
'PersonId' => 123,
'Rank' => 123,
'Tooltip' => '<string>',
'GroupIdx' => 123,
'FullName' => '<string>',
'FormalName' => '<string>',
'Deleted' => true,
'EjUserId' => 123,
'UserName' => '<string>',
'ExtraFields' => [
],
'CustomFields' => [
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'Updated' => '2023-11-07T05:31:56Z',
'UpdatedAssociate' => [
'AssociateId' => 123,
'Name' => '<string>',
'PersonId' => 123,
'Rank' => 123,
'Tooltip' => '<string>',
'GroupIdx' => 123,
'FullName' => '<string>',
'FormalName' => '<string>',
'Deleted' => true,
'EjUserId' => 123,
'UserName' => '<string>',
'ExtraFields' => [
],
'CustomFields' => [
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'ErrorsEmail' => '<string>',
'ErrorEmails' => [
'<string>'
],
'ErrorAssociates' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ChildItems' => '<array>',
'IconHint' => '<string>',
'ColorBlock' => 123,
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'Description' => '<string>',
'TotalCalls' => 123,
'TotalErrors' => 123,
'ConsecutiveErrors' => 123,
'LastError' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:53294/api/v1/Agents/Webhook/TestWebhook"
payload = { "Webhook": {
"WebhookId": 123,
"Name": "<string>",
"Events": ["<string>"],
"TargetUrl": "<string>",
"Secret": "<string>",
"Type": "<string>",
"Headers": {},
"Properties": {},
"Registered": "2023-11-07T05:31:56Z",
"RegisteredAssociate": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": True,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Updated": "2023-11-07T05:31:56Z",
"UpdatedAssociate": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": True,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"ErrorsEmail": "<string>",
"ErrorEmails": ["<string>"],
"ErrorAssociates": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"Description": "<string>",
"TotalCalls": 123,
"TotalErrors": 123,
"ConsecutiveErrors": 123,
"LastError": "<string>"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Webhook: {
WebhookId: 123,
Name: '<string>',
Events: ['<string>'],
TargetUrl: '<string>',
Secret: '<string>',
Type: '<string>',
Headers: {},
Properties: {},
Registered: '2023-11-07T05:31:56Z',
RegisteredAssociate: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Updated: '2023-11-07T05:31:56Z',
UpdatedAssociate: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
ErrorsEmail: '<string>',
ErrorEmails: ['<string>'],
ErrorAssociates: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Description: '<string>',
TotalCalls: 123,
TotalErrors: 123,
ConsecutiveErrors: 123,
LastError: '<string>'
}
})
};
fetch('http://localhost:53294/api/v1/Agents/Webhook/TestWebhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"Success": true,
"Message": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Test Webhook
Pings a webhook with a ‘test’ event, returns SUCCESS(true) or FAILURE(false) + the response from the webhook target.
NsApiSlow threshold: 2000 ms.
Test Webhook
using RestSharp;
var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Webhook/TestWebhook");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"Webhook\": {\n \"WebhookId\": 123,\n \"Name\": \"<string>\",\n \"Events\": [\n \"<string>\"\n ],\n \"TargetUrl\": \"<string>\",\n \"Secret\": \"<string>\",\n \"Type\": \"<string>\",\n \"Headers\": {},\n \"Properties\": {},\n \"Registered\": \"2023-11-07T05:31:56Z\",\n \"RegisteredAssociate\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"PersonId\": 123,\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"GroupIdx\": 123,\n \"FullName\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"Deleted\": true,\n \"EjUserId\": 123,\n \"UserName\": \"<string>\",\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"Updated\": \"2023-11-07T05:31:56Z\",\n \"UpdatedAssociate\": {\n \"AssociateId\": 123,\n \"Name\": \"<string>\",\n \"PersonId\": 123,\n \"Rank\": 123,\n \"Tooltip\": \"<string>\",\n \"GroupIdx\": 123,\n \"FullName\": \"<string>\",\n \"FormalName\": \"<string>\",\n \"Deleted\": true,\n \"EjUserId\": 123,\n \"UserName\": \"<string>\",\n \"ExtraFields\": {},\n \"CustomFields\": {},\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n },\n \"ErrorsEmail\": \"<string>\",\n \"ErrorEmails\": [\n \"<string>\"\n ],\n \"ErrorAssociates\": [\n {\n \"Id\": 123,\n \"Name\": \"<string>\",\n \"ToolTip\": \"<string>\",\n \"Deleted\": true,\n \"Rank\": 123,\n \"Type\": \"<string>\",\n \"ChildItems\": \"<array>\",\n \"IconHint\": \"<string>\",\n \"ColorBlock\": 123,\n \"ExtraInfo\": \"<string>\",\n \"StyleHint\": \"<string>\",\n \"FullName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ],\n \"Description\": \"<string>\",\n \"TotalCalls\": 123,\n \"TotalErrors\": 123,\n \"ConsecutiveErrors\": 123,\n \"LastError\": \"<string>\"\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Webhook: {
WebhookId: 123,
Name: '<string>',
Events: ['<string>'],
TargetUrl: '<string>',
Secret: '<string>',
Type: '<string>',
Headers: {},
Properties: {},
Registered: '2023-11-07T05:31:56Z',
RegisteredAssociate: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Updated: '2023-11-07T05:31:56Z',
UpdatedAssociate: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
ErrorsEmail: '<string>',
ErrorEmails: ['<string>'],
ErrorAssociates: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Description: '<string>',
TotalCalls: 123,
TotalErrors: 123,
ConsecutiveErrors: 123,
LastError: '<string>'
}
})
};
fetch('http://localhost:53294/api/v1/Agents/Webhook/TestWebhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "53294",
CURLOPT_URL => "http://localhost:53294/api/v1/Agents/Webhook/TestWebhook",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'Webhook' => [
'WebhookId' => 123,
'Name' => '<string>',
'Events' => [
'<string>'
],
'TargetUrl' => '<string>',
'Secret' => '<string>',
'Type' => '<string>',
'Headers' => [
],
'Properties' => [
],
'Registered' => '2023-11-07T05:31:56Z',
'RegisteredAssociate' => [
'AssociateId' => 123,
'Name' => '<string>',
'PersonId' => 123,
'Rank' => 123,
'Tooltip' => '<string>',
'GroupIdx' => 123,
'FullName' => '<string>',
'FormalName' => '<string>',
'Deleted' => true,
'EjUserId' => 123,
'UserName' => '<string>',
'ExtraFields' => [
],
'CustomFields' => [
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'Updated' => '2023-11-07T05:31:56Z',
'UpdatedAssociate' => [
'AssociateId' => 123,
'Name' => '<string>',
'PersonId' => 123,
'Rank' => 123,
'Tooltip' => '<string>',
'GroupIdx' => 123,
'FullName' => '<string>',
'FormalName' => '<string>',
'Deleted' => true,
'EjUserId' => 123,
'UserName' => '<string>',
'ExtraFields' => [
],
'CustomFields' => [
],
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
],
'ErrorsEmail' => '<string>',
'ErrorEmails' => [
'<string>'
],
'ErrorAssociates' => [
[
'Id' => 123,
'Name' => '<string>',
'ToolTip' => '<string>',
'Deleted' => true,
'Rank' => 123,
'Type' => '<string>',
'ChildItems' => '<array>',
'IconHint' => '<string>',
'ColorBlock' => 123,
'ExtraInfo' => '<string>',
'StyleHint' => '<string>',
'FullName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
],
'Description' => '<string>',
'TotalCalls' => 123,
'TotalErrors' => 123,
'ConsecutiveErrors' => 123,
'LastError' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:53294/api/v1/Agents/Webhook/TestWebhook"
payload = { "Webhook": {
"WebhookId": 123,
"Name": "<string>",
"Events": ["<string>"],
"TargetUrl": "<string>",
"Secret": "<string>",
"Type": "<string>",
"Headers": {},
"Properties": {},
"Registered": "2023-11-07T05:31:56Z",
"RegisteredAssociate": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": True,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"Updated": "2023-11-07T05:31:56Z",
"UpdatedAssociate": {
"AssociateId": 123,
"Name": "<string>",
"PersonId": 123,
"Rank": 123,
"Tooltip": "<string>",
"GroupIdx": 123,
"FullName": "<string>",
"FormalName": "<string>",
"Deleted": True,
"EjUserId": 123,
"UserName": "<string>",
"ExtraFields": {},
"CustomFields": {},
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
},
"ErrorsEmail": "<string>",
"ErrorEmails": ["<string>"],
"ErrorAssociates": [
{
"Id": 123,
"Name": "<string>",
"ToolTip": "<string>",
"Deleted": True,
"Rank": 123,
"Type": "<string>",
"ChildItems": "<array>",
"IconHint": "<string>",
"ColorBlock": 123,
"ExtraInfo": "<string>",
"StyleHint": "<string>",
"FullName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
],
"Description": "<string>",
"TotalCalls": 123,
"TotalErrors": 123,
"ConsecutiveErrors": 123,
"LastError": "<string>"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Webhook: {
WebhookId: 123,
Name: '<string>',
Events: ['<string>'],
TargetUrl: '<string>',
Secret: '<string>',
Type: '<string>',
Headers: {},
Properties: {},
Registered: '2023-11-07T05:31:56Z',
RegisteredAssociate: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
Updated: '2023-11-07T05:31:56Z',
UpdatedAssociate: {
AssociateId: 123,
Name: '<string>',
PersonId: 123,
Rank: 123,
Tooltip: '<string>',
GroupIdx: 123,
FullName: '<string>',
FormalName: '<string>',
Deleted: true,
EjUserId: 123,
UserName: '<string>',
ExtraFields: {},
CustomFields: {},
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
},
ErrorsEmail: '<string>',
ErrorEmails: ['<string>'],
ErrorAssociates: [
{
Id: 123,
Name: '<string>',
ToolTip: '<string>',
Deleted: true,
Rank: 123,
Type: '<string>',
ChildItems: '<array>',
IconHint: '<string>',
ColorBlock: 123,
ExtraInfo: '<string>',
StyleHint: '<string>',
FullName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
],
Description: '<string>',
TotalCalls: 123,
TotalErrors: 123,
ConsecutiveErrors: 123,
LastError: '<string>'
}
})
};
fetch('http://localhost:53294/api/v1/Agents/Webhook/TestWebhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"Success": true,
"Message": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}Authorizations
SuperOffice username:password are passed in Base64-encoded.
You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.
SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/
passing in the application id and redirect URL.
SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)
https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f
You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.
FlowImplicit
- Authorization URL
- https://online.superoffice.com/login/common/oauth/authorize
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
Webhook
TestWebhook: Pings a webhook with a 'test' event, returns SUCCESS(true) or FAILURE(false) + the response from the webhook target.
Webhook definitions. Webhooks broadcast events from NetServer to remote servers. Carrier object for Webhook. Services for the Webhook Carrier is available from the Webhook Agent.
Show child attributes
Show child attributes
Response
OK
Result of calling a webhook Carrier object for WebhookResult. Services for the WebhookResult Carrier is available from the Webhook Agent.
Was call to webhook successful? (200 OK)
Headers and body of response from webhook
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Show child attributes
Show child attributes
Field property dictionary mapping field names to field access rights.
Show child attributes
Show child attributes