Chilkat Online Tools

phpAx / easybill REST API / Update WebHook

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "url": "<string>",
//   "content_type": "json",
//   "secret": "<string>",
//   "events": [
//     "position.update",
//     "document.create"
//   ],
//   "description": "<string>",
//   "id": "<long>",
//   "is_active": false,
//   "last_response": {
//     "date": "<dateTime>",
//     "code": "<integer>",
//     "response": "<string>"
//   }
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('url','<string>');
$json->UpdateString('content_type','json');
$json->UpdateString('secret','<string>');
$json->UpdateString('events[0]','position.update');
$json->UpdateString('events[1]','document.create');
$json->UpdateString('description','<string>');
$json->UpdateString('id','<long>');
$json->UpdateBool('is_active',0);
$json->UpdateString('last_response.date','<dateTime>');
$json->UpdateString('last_response.code','<integer>');
$json->UpdateString('last_response.response','<string>');

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Authorization','{{apiKey}}');
$http->SetRequestHeader('Accept','application/json');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PUT','https://api.easybill.de/rest/v1/webhooks/:id',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "url": "<string>",
//   "content_type": "json",
//   "secret": "<string>",
//   "events": [
//     "position.update",
//     "document.create"
//   ],
//   "description": "<string>",
//   "id": "<long>",
//   "is_active": false,
//   "last_response": {
//     "date": "<dateTime>",
//     "code": "<integer>",
//     "response": "<string>"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$url = $jResp->stringOf('url');
$content_type = $jResp->stringOf('content_type');
$secret = $jResp->stringOf('secret');
$description = $jResp->stringOf('description');
$id = $jResp->stringOf('id');
$is_active = $jResp->BoolOf('is_active');
$Date = $jResp->stringOf('last_response.date');
$Code = $jResp->stringOf('last_response.code');
$Response = $jResp->stringOf('last_response.response');
$i = 0;
$count_i = $jResp->SizeOfArray('events');
while ($i < $count_i) {
    $jResp->I = $i;
    $strVal = $jResp->stringOf('events[i]');
    $i = $i + 1;
}


?>

Curl Command

curl -X PUT
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "url": "<string>",
  "content_type": "json",
  "secret": "<string>",
  "events": [
    "position.update",
    "document.create"
  ],
  "description": "<string>",
  "id": "<long>",
  "is_active": false,
  "last_response": {
    "date": "<dateTime>",
    "code": "<integer>",
    "response": "<string>"
  }
}'
https://api.easybill.de/rest/v1/webhooks/:id

Postman Collection Item JSON

{
  "name": "Update WebHook",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"url\": \"<string>\",\n  \"content_type\": \"json\",\n  \"secret\": \"<string>\",\n  \"events\": [\n    \"position.update\",\n    \"document.create\"\n  ],\n  \"description\": \"<string>\",\n  \"id\": \"<long>\",\n  \"is_active\": false,\n  \"last_response\": {\n    \"date\": \"<dateTime>\",\n    \"code\": \"<integer>\",\n    \"response\": \"<string>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/webhooks/:id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "webhooks",
        ":id"
      ],
      "variable": [
        {
          "key": "id",
          "value": "<long>",
          "description": "(Required) ID of WebHook"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"url\": \"<string>\",\n  \"content_type\": \"json\",\n  \"secret\": \"<string>\",\n  \"events\": [\n    \"position.update\",\n    \"document.create\"\n  ],\n  \"description\": \"<string>\",\n  \"id\": \"<long>\",\n  \"is_active\": false,\n  \"last_response\": {\n    \"date\": \"<dateTime>\",\n    \"code\": \"<integer>\",\n    \"response\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/webhooks/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webhooks",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"url\": \"<string>\",\n  \"content_type\": \"json\",\n  \"secret\": \"<string>\",\n  \"events\": [\n    \"position.update\",\n    \"document.create\"\n  ],\n  \"description\": \"<string>\",\n  \"id\": \"<long>\",\n  \"is_active\": false,\n  \"last_response\": {\n    \"date\": \"<dateTime>\",\n    \"code\": \"<integer>\",\n    \"response\": \"<string>\"\n  }\n}"
    },
    {
      "name": "Not found",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"url\": \"<string>\",\n  \"content_type\": \"json\",\n  \"secret\": \"<string>\",\n  \"events\": [\n    \"position.update\",\n    \"document.create\"\n  ],\n  \"description\": \"<string>\",\n  \"id\": \"<long>\",\n  \"is_active\": false,\n  \"last_response\": {\n    \"date\": \"<dateTime>\",\n    \"code\": \"<integer>\",\n    \"response\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/webhooks/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webhooks",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"url\": \"<string>\",\n  \"content_type\": \"json\",\n  \"secret\": \"<string>\",\n  \"events\": [\n    \"position.update\",\n    \"document.create\"\n  ],\n  \"description\": \"<string>\",\n  \"id\": \"<long>\",\n  \"is_active\": false,\n  \"last_response\": {\n    \"date\": \"<dateTime>\",\n    \"code\": \"<integer>\",\n    \"response\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/webhooks/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webhooks",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}