Chilkat Online Tools

Perl / Fatture in Cloud API v2 - API Reference / Create a Webhook Subscription

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

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

# The following JSON is sent in the request body.

# {
#   "data": {
#     "id": "<string>",
#     "sink": "<string>",
#     "verified": "<boolean>",
#     "types": [
#       "it.fattureincloud.webhooks.receipts.delete",
#       "it.fattureincloud.webhooks.issued_documents.self_invoices.delete"
#     ]
#   }
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("data.id","<string>");
$json->UpdateString("data.sink","<string>");
$json->UpdateString("data.verified","<boolean>");
$json->UpdateString("data.types[0]","it.fattureincloud.webhooks.receipts.delete");
$json->UpdateString("data.types[1]","it.fattureincloud.webhooks.issued_documents.self_invoices.delete");

$http->SetRequestHeader("Content-Type","application/json");
# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");
$http->SetRequestHeader("Accept","application/json");

# resp is a HttpResponse
$resp = $http->PostJson3("https://api-v2.fattureincloud.it/c/:company_id/subscriptions","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

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

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

    exit;
}

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

# {
#   "data": {
#     "id": "<string>",
#     "sink": "<string>",
#     "verified": "<boolean>",
#     "types": [
#       "it.fattureincloud.webhooks.receipts.delete",
#       "it.fattureincloud.webhooks.issued_documents.work_reports.create"
#     ]
#   },
#   "warnings": [
#     "<string>",
#     "<string>"
#   ]
# }

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

$Id = $jResp->stringOf("data.id");
$Sink = $jResp->stringOf("data.sink");
$Verified = $jResp->stringOf("data.verified");
$i = 0;
$count_i = $jResp->SizeOfArray("data.types");
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf("data.types[i]");
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray("warnings");
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf("warnings[i]");
    $i = $i + 1;
}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "id": "<string>",
    "sink": "<string>",
    "verified": "<boolean>",
    "types": [
      "it.fattureincloud.webhooks.receipts.delete",
      "it.fattureincloud.webhooks.issued_documents.self_invoices.delete"
    ]
  }
}'
https://api-v2.fattureincloud.it/c/:company_id/subscriptions

Postman Collection Item JSON

{
  "name": "Create a Webhook Subscription",
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": [
        {
          "key": "scope",
          "value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
          "type": "string"
        },
        {
          "key": "redirect_uri",
          "value": "https://api-v2.fattureincloud.it/oauth/token",
          "type": "string"
        },
        {
          "key": "accessTokenUrl",
          "value": "https://api-v2.fattureincloud.it/oauth/token",
          "type": "string"
        },
        {
          "key": "authUrl",
          "value": "https://api-v2.fattureincloud.it/oauth/authorize",
          "type": "string"
        },
        {
          "key": "grant_type",
          "value": "authorization_code",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"sink\": \"<string>\",\n    \"verified\": \"<boolean>\",\n    \"types\": [\n      \"it.fattureincloud.webhooks.receipts.delete\",\n      \"it.fattureincloud.webhooks.issued_documents.self_invoices.delete\"\n    ]\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/subscriptions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "subscriptions"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Register some webhooks Subscriptions."
  },
  "response": [
    {
      "name": "Example response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"sink\": \"<string>\",\n    \"verified\": \"<boolean>\",\n    \"types\": [\n      \"it.fattureincloud.webhooks.receipts.delete\",\n      \"it.fattureincloud.webhooks.issued_documents.self_invoices.delete\"\n    ]\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/subscriptions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "subscriptions"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"sink\": \"<string>\",\n    \"verified\": \"<boolean>\",\n    \"types\": [\n      \"it.fattureincloud.webhooks.receipts.delete\",\n      \"it.fattureincloud.webhooks.issued_documents.work_reports.create\"\n    ]\n  },\n  \"warnings\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}"
    }
  ]
}