{"_id":"573f3f6c87cbd20e00208e77","editedParams":true,"editedParams2":true,"user":"5564f227f0f70f0d00a9ab20","category":{"_id":"573f3f6c87cbd20e00208e49","version":"573f3f6c87cbd20e00208e42","__v":0,"project":"573f3f6c87cbd20e00208e41","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-20T16:02:55.724Z","from_sync":false,"order":4,"slug":"flow-triggers","title":"Flow Triggers"},"project":"573f3f6c87cbd20e00208e41","version":{"_id":"573f3f6c87cbd20e00208e42","__v":2,"project":"573f3f6c87cbd20e00208e41","createdAt":"2016-05-18T20:59:16.635Z","releaseDate":"2016-05-18T20:59:16.635Z","categories":["573f3f6c87cbd20e00208e44","573f3f6c87cbd20e00208e43","573f3f6c87cbd20e00208e45","573f3f6c87cbd20e00208e46","573f3f6c87cbd20e00208e47","573f3f6c87cbd20e00208e48","573f3f6c87cbd20e00208e49","573f3f6c87cbd20e00208e4a","573f3f6c87cbd20e00208e4b","579a382265f89a170099946f","57bce03036eff81700666963"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-20T16:30:47.839Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"name":"","code":"{\n  \"triggered\":true\n}","language":"json","status":204}]},"settings":"573f36307eeb8b190094cab0","examples":{"codes":[{"code":"# With no data\ncurl -X POST \\\n  https://triggers.octoblu.com/flows/triggers/DoIt\n\n# With form-urlencoded data\ncurl -X POST \\\n  -d foo=bar \\\n  https://triggers.octoblu.com/flows/triggers/DoIt\n\n# With JSON data\ncurl -X POST \\\n  -H 'content-type: application/json' \\\n  -d '{\"foo\": \"bar\"}' \\\n  https://triggers.octoblu.com/flows/triggers/DoIt\n\n# With custom authentication\nUUID=fd205f32-7846-4057-911b-3d580747b6c9\nTOKEN=9f63aaa056618ee5c79197660c4de874718e41da\n\ncurl -X POST \\\n  https://${UUID}:${TOKEN}:::at:::triggers.octoblu.com/flows/triggers/DoIt\n","language":"curl"},{"code":"# With no data\nInvoke-RestMethod  `\n  -URI \"https://triggers.octoblu.com/flows/triggers/DoIt\" `\n  -Method Post\n\n# With form-urlencoded data\nInvoke-RestMethod  `\n  -URI \"https://triggers.octoblu.com/flows/triggers/DoIt\" `\n  -Method Post `\n  -Body @{'foo'='bar'}\n\n# With JSON data\nInvoke-RestMethod  `\n  -URI \"https://triggers.octoblu.com/flows/triggers/DoIt\" `\n  -ContentType \"application/json\" `\n  -Method Post `\n  -Body '{\"foo\":\"bar\"}'\n\n# With custom authentication\n$meAuth = @{meshblu_auth_uuid='fd205f32-7846-4057-911b-3d580747b6c9'; meshblu_auth_token='9f63aaa056618ee5c79197660c4de874718e41da'}\n\nInvoke-RestMethod  `\n  -URI \"https://triggers.octoblu.com/flows/triggers/DoIt\" `\n  -Headers $meAuth `\n  -Method Post\n","language":"text","name":"PowerShell"}]},"auth":"optional","params":[{"_id":"573f3b5cdbf53019002fac06","ref":"","in":"path","required":false,"desc":"","default":"","type":"string","name":"trigger_name"}],"url":"/flows/triggers/:trigger_name"},"isReference":false,"order":5,"body":"This causes the trigger service to send a Meshblu message to the flow to tell it to trigger. If no authentication information is passed, it will send the message as the identity of the Trigger Service.\n\nAdditionally, any POST data sent will be made available to the flow\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"In order to activate the trigger, the trigger service's UUID must be in the flow's `message.from` whitelist. Generally, the [Octoblu](https://octoblu.com) Designer will manage the Whitelist for the user. See the [Meshblu whitelist documentation](https://meshblu.readme.io/docs/whitelists-2-0) for more information.\",\n  \"title\": \"Check the Permissions\"\n}\n[/block]","excerpt":"Activate a trigger in a flow by name","slug":"trigger-by-name","type":"endpoint","title":"Trigger by Name"}

postTrigger by Name

Activate a trigger in a flow by name

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

trigger_name:
string

Examples


Result Format


Documentation

This causes the trigger service to send a Meshblu message to the flow to tell it to trigger. If no authentication information is passed, it will send the message as the identity of the Trigger Service. Additionally, any POST data sent will be made available to the flow [block:callout] { "type": "warning", "body": "In order to activate the trigger, the trigger service's UUID must be in the flow's `message.from` whitelist. Generally, the [Octoblu](https://octoblu.com) Designer will manage the Whitelist for the user. See the [Meshblu whitelist documentation](https://meshblu.readme.io/docs/whitelists-2-0) for more information.", "title": "Check the Permissions" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}