PureBasic / Postman API / Create Webhook
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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}}"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"webhook.name","{{webhook_name}}")
CkJsonObject::ckUpdateString(json,"webhook.collection","{{collection_uid}}")
CkHttp::ckSetRequestHeader(http,"X-API-Key","{{postman_api_key}}")
resp.i = CkHttp::ckPostJson3(http,"https://api.getpostman.com/webhooks?workspace={{workspace_id}}","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
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}"
}
]
}