Chilkat Online Tools

VB.NET / Commercetools / Create Subscription

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

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

' The following JSON is sent in the request body.

' {
'   "destination": {
'     "type": "IronMQ",
'     "uri": "https://queue-uri"
'   },
'   "messages": [
'     {
'       "resourceTypeId": "product",
'       "types": [
'       ]
'     }
'   ],
'   "key": "test-queue"
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("destination.type","IronMQ")
json.UpdateString("destination.uri","https://queue-uri")
json.UpdateString("messages[0].resourceTypeId","product")
json.UpdateNewArray("messages[0].types")
json.UpdateString("key","test-queue")

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")

Dim sbRequestBody As New Chilkat.StringBuilder
json.EmitSb(sbRequestBody)

Dim resp As Chilkat.HttpResponse = http.PTextSb("post","https://domain.com/{{project-key}}/subscriptions",sbRequestBody,"utf-8","application/json",False,False)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "destination" : {
    "type" : "IronMQ",
    "uri" : "https://queue-uri"
  },
  "messages" : [ {
    "resourceTypeId" : "product",
    "types" : [ ]
  } ],
  "key" : "test-queue"
}'
https://domain.com/{{project-key}}/subscriptions

Postman Collection Item JSON

{
  "name": "Create Subscription",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "tests[\"Status code \" + responseCode.code] = responseCode.code === 200 || responseCode.code === 201;",
          "var data = JSON.parse(responseBody);",
          "if(data.results && data.results[0] && data.results[0].id && data.results[0].version){",
          "    pm.environment.set(\"subscription-id\", data.results[0].id); ",
          "    pm.environment.set(\"subscription-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"subscription-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"subscription-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"subscription-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"subscription-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/subscriptions",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "subscriptions"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "The creation of a Subscription is eventually consistent, it may take up to a minute before it becomes fully active.\nIn order to test that the destination is correctly configured, a test message will be put into the queue.\nIf the message could not be delivered, the subscription will not be created.\nThe payload of the test message is a notification of type ResourceCreated for the resourceTypeId subscription.\nCurrently, a maximum of 25 subscriptions can be created per project.\n",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"destination\" : {\n    \"type\" : \"IronMQ\",\n    \"uri\" : \"https:\/\/queue-uri\"\n  },\n  \"messages\" : [ {\n    \"resourceTypeId\" : \"product\",\n    \"types\" : [ ]\n  } ],\n  \"key\" : \"test-queue\"\n}"
    }
  },
  "response": [
  ]
}