Chilkat Online Tools

Objective-C / Postman API / Create Webhook

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

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

// {
//   "webhook": {
//     "name": "{{webhook_name}}",
//     "collection": "{{collection_uid}}"
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"webhook.name" value: @"{{webhook_name}}"];
[json UpdateString: @"webhook.collection" value: @"{{collection_uid}}"];

[http SetRequestHeader: @"X-API-Key" value: @"{{postman_api_key}}"];

CkoHttpResponse *resp = [http PostJson3: @"https://api.getpostman.com/webhooks?workspace={{workspace_id}}" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -X POST
	-H "X-API-Key: {{postman_api_key}}"
	-d '{
    "webhook":{
        "name": "{{webhook_name}}",
        "collection": "{{collection_uid}}"
    }
}'
https://api.getpostman.com/webhooks?workspace={{workspace_id}}

Postman Collection Item JSON

{
  "name": "Create Webhook",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"webhook\":{\n        \"name\": \"{{webhook_name}}\",\n        \"collection\": \"{{collection_uid}}\"\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.getpostman.com/webhooks?workspace={{workspace_id}}",
      "protocol": "https",
      "host": [
        "api",
        "getpostman",
        "com"
      ],
      "path": [
        "webhooks"
      ],
      "query": [
        {
          "key": "workspace",
          "value": "{{workspace_id}}"
        }
      ]
    },
    "description": "Create a webhook that triggers a collection with your custom payload.\n\nYou can specify the webhook name and the collection to trigger by using the following attributes of the `webhook` object on your JSON body:\n\n* `name`: the name of the webhook that you're creating.\n* `collection`: the UID of the collection that you want to trigger once this webhook is called.\n\nOnce created, the webhook URL can be retrieved by accessing the `webhookUrl` attribute of the `webhook` object on the response JSON payload."
  },
  "response": [
    {
      "name": "Create Webhook",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "x-workspace-id",
            "value": "c90a3482-f80d-43d6-9dfb-0830f5e43605",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"webhook\":{\n        \"name\": \"Sample Webhook\",\n        \"collection\": \"13223329-78f7e7dd-e9f4-4607-9610-098524f06589\"\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "https://api.getpostman.com/webhooks?workspace={{workspace_id}}",
          "protocol": "https",
          "host": [
            "api",
            "getpostman",
            "com"
          ],
          "path": [
            "webhooks"
          ],
          "query": [
            {
              "key": "workspace",
              "value": "{{workspace_id}}"
            }
          ]
        }
      },
      "_postman_previewlanguage": "json",
      "header": null,
      "cookie": [
      ],
      "body": "{\n    \"webhook\": {\n        \"id\": \"1eba1c36-c343-4eb0-a25a-37117650e628\",\n        \"name\": \"Sample Webhook\",\n        \"collection\": \"13323329-78f7e7dd-e9f4-4607-9610-098524f06589\",\n        \"webhookUrl\": \"https://example.com/webhookUrl\",\n        \"uid\": \"13323329-1eba1c36-c343-4eb0-a25a-37117650e628\"\n    }\n}"
    }
  ]
}