Save Webhook

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Webhook/SaveWebhook");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\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}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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:56350/api/v1/Agents/Webhook/SaveWebhook', 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 => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Webhook/SaveWebhook",
  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([
    '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 => [
    "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:56350/api/v1/Agents/Webhook/SaveWebhook"

payload = {
    "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 = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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:56350/api/v1/Agents/Webhook/SaveWebhook', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "WebhookId": 123,
  "Name": "<string>",
  "Events": [
    "<string>"
  ],
  "TargetUrl": "<string>",
  "Secret": "<string>",
  "State": "Unknown",
  "Type": "<string>",
  "Headers": {},
  "Properties": {},
  "Registered": "2023-11-07T05:31:56Z",
  "RegisteredAssociate": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "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>",
    "Type": "Unknown",
    "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>",
  "NotifyVia": "None",
  "NotifyWhen": "None",
  "TotalCalls": 123,
  "TotalErrors": 123,
  "ConsecutiveErrors": 123,
  "LastError": "<string>"
}

Save Webhook

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Webhook/SaveWebhook");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\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}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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:56350/api/v1/Agents/Webhook/SaveWebhook', 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 => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Webhook/SaveWebhook",
  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([
    '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 => [
    "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:56350/api/v1/Agents/Webhook/SaveWebhook"

payload = {
    "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 = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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:56350/api/v1/Agents/Webhook/SaveWebhook', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "WebhookId": 123,
  "Name": "<string>",
  "Events": [
    "<string>"
  ],
  "TargetUrl": "<string>",
  "Secret": "<string>",
  "State": "Unknown",
  "Type": "<string>",
  "Headers": {},
  "Properties": {},
  "Registered": "2023-11-07T05:31:56Z",
  "RegisteredAssociate": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "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>",
    "Type": "Unknown",
    "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>",
  "NotifyVia": "None",
  "NotifyWhen": "None",
  "TotalCalls": 123,
  "TotalErrors": 123,
  "ConsecutiveErrors": 123,
  "LastError": "<string>"
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Body

The Webhook that is saved

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.

WebhookId

integer<int32>

Primary Key. Unique id for this webhook.

Name

string

Name to identify this webhook. Does not have to be unique.

Events

string[]

Array of event names that trigger this webhook: ['contact.created', 'sale.changed']

TargetUrl

string

Destination to POST event info to. URL for webhooks. Id for CRM scripts

Secret

string

Shared secret key used for generating SHA256 HMAC signature, so that receiver can verify that call came from this server

State

enum<string>

Webhook status - should we post events to the URL? 1=Active, 2=Stopped or 3=TooManyErrors

Available options:

Unknown,

Active,

Stopped,

TooManyErrors

Type

string

Name of plugin that handles this webhook. 'webhook' for HTTP POST notifications, 'crmscript' for script invocations.

Headers

object

Custom HTTP Headers to add to webhook requests.

Show child attributes

Properties

object

Custom values to inject into JSON body of webhook call.

Show child attributes

Registered

string<date-time>

Registered when in UTC.

RegisteredAssociate

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

Updated

string<date-time>

Last updated when in UTC.

UpdatedAssociate

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

ErrorsEmail

string

Obsolete, use ErrorEmails instead

ErrorEmails

string[]

Email addresses to notify when this webhook is disabled.

ErrorAssociates

object[]

Associates to notify when this webhook is disabled.

Show child attributes

Description

string

Human-readable description of what this webhook does.

NotifyVia

enum<string>

How to notify recipients when this webhook changes state. 1=Email, 2=InApp.

Available options:

None,

Email,

InApp

NotifyWhen

enum<string>

When to notify recipients. Bitflag: 1=FirstFailure, 2=Disabling.

Available options:

None,

FirstFailure,

Disabling

TotalCalls

integer<int32>

Number of times webhook has been invoked since registered. For statistical purposes.

TotalErrors

integer<int32>

Number of times webhook has returned error since registered. For statistical purposes.

ConsecutiveErrors

integer<int32>

Number of consecutive errors. Reset to 0 when an non-error is received. If too many errors, webhook.state is changed to TooManyErrors(3) to deactivate webhook.

LastError

string

Most recent error message received from target. HTTP Headers + body. To help with debugging webhooks.

Response

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.

WebhookId

integer<int32>

Primary Key. Unique id for this webhook.

Name

string

Name to identify this webhook. Does not have to be unique.

Events

string[]

Array of event names that trigger this webhook: ['contact.created', 'sale.changed']

TargetUrl

string

Destination to POST event info to. URL for webhooks. Id for CRM scripts

Secret

string

Shared secret key used for generating SHA256 HMAC signature, so that receiver can verify that call came from this server

State

enum<string>

Webhook status - should we post events to the URL? 1=Active, 2=Stopped or 3=TooManyErrors

Available options:

Unknown,

Active,

Stopped,

TooManyErrors

Type

string

Name of plugin that handles this webhook. 'webhook' for HTTP POST notifications, 'crmscript' for script invocations.

Headers

object

Custom HTTP Headers to add to webhook requests.

Show child attributes

Properties

object

Custom values to inject into JSON body of webhook call.

Show child attributes

Registered

string<date-time>

Registered when in UTC.

RegisteredAssociate

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

Updated

string<date-time>

Last updated when in UTC.

UpdatedAssociate

object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Show child attributes

ErrorsEmail

string

Obsolete, use ErrorEmails instead

ErrorEmails

string[]

Email addresses to notify when this webhook is disabled.

ErrorAssociates

object[]

Associates to notify when this webhook is disabled.

Show child attributes

Description

string

Human-readable description of what this webhook does.

NotifyVia

enum<string>

How to notify recipients when this webhook changes state. 1=Email, 2=InApp.

Available options:

None,

Email,

InApp

NotifyWhen

enum<string>

When to notify recipients. Bitflag: 1=FirstFailure, 2=Disabling.

Available options:

None,

FirstFailure,

Disabling

TotalCalls

integer<int32>

Number of times webhook has been invoked since registered. For statistical purposes.

TotalErrors

integer<int32>

Number of times webhook has returned error since registered. For statistical purposes.

ConsecutiveErrors

integer<int32>

Number of consecutive errors. Reset to 0 when an non-error is received. If too many errors, webhook.state is changed to TooManyErrors(3) to deactivate webhook.

LastError

string

Most recent error message received from target. HTTP Headers + body. To help with debugging webhooks.