{"_id":"56c5062bbdcde80d00498669","githubsync":"","user":"54774c47f3736008009e9e0c","category":{"_id":"56c50628bdcde80d0049863d","version":"56c50626bdcde80d00498635","pages":["56c5062bbdcde80d00498667","56c5062bbdcde80d00498668","56c5062bbdcde80d00498669","56c5062bbdcde80d0049866a","56c5062bbdcde80d0049866b","56c5062bbdcde80d0049866c","56c5062bbdcde80d0049866d","56c5062bbdcde80d0049866e"],"project":"54774d9af3736008009e9e0e","__v":1,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-17T14:11:48.317Z","from_sync":false,"order":8,"slug":"triggers","title":"Triggers"},"editedParams":true,"parentDoc":null,"project":"54774d9af3736008009e9e0e","version":{"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z","categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"API v1.1","version_clean":"0.1.1","version":"0.1.1"},"__v":0,"editedParams2":true,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-26T16:37:04.191Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"label\":\"TRIGGER_LABEL\",\n     \"script\":1,\n     \"class\":\"DATA_CLASS_NAME\",\n     \"signal\":\"post_create\"}' \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/triggers/\"","name":""},{"language":"python","code":"import syncano\nfrom syncano.models import Trigger\n\nsyncano.connect(api_key=\"ACCOUNT_KEY\", instance_name=\"INSTANCE_NAME\")\n\nTrigger.please.create(\n    label=\"TRIGGER_LABEL\",\n    script=SCRIPT_ID,\n    class_name=\"CLASS_NAME\",\n    signal=\"post_create\",\n)\n"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar Trigger = connection.Trigger;\n\nvar options = {\n  \"label\": TRIGGER_LABEL,\n  \"codebox\": 1,\n  \"class\": CLASS_NAME,\n  \"signal\": \"post_create\",\n  \"instanceName\": \"INSTANCE_NAME\"\n};\n\nTrigger.please().create(options).then(callback)","language":"javascript"}]},"method":"post","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"description\": \"\",\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/triggers/14/\",\n    \"traces\": \"/v1.1/instances/rivia/triggers/14/traces/\",\n    \"class\": \"/v1.1/instances/rivia/classes/witchers/\",\n    \"script\": \"/v1.1/instances/rivia/snippets/scripts/1/\"\n  },\n  \"script\": 1,\n  \"created_at\": \"2016-03-11T19:47:29.642784Z\",\n  \"updated_at\": \"2016-03-11T19:47:29.642809Z\",\n  \"id\": 14,\n  \"class\": \"witchers\",\n  \"label\": \"after-create-witcher\",\n  \"signal\": \"post_create\"\n}"},{"code":"{\n  \"signal\": [\n    \"Select a valid choice. post_removal is not one of the available choices.\"\n  ]\n}","language":"json","status":400,"name":""},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"status":404,"language":"json","code":"{\n  \"detail\": \"Instance was not found.\"\n}"}]},"settings":"56c50c06d1b8770d00922288","auth":"required","params":[{"_id":"54ef26a74b06700d0062d151","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"},{"_id":"5564b405f0f70f0d00a9aa8d","ref":"","in":"body","required":true,"desc":"Trigger label","default":"","type":"string","name":"label"},{"_id":"54ef49745bf74a0d00ef4116","ref":"","in":"body","required":true,"desc":"Data Class name","default":"","type":"string","name":"class"},{"_id":"54ef49745bf74a0d00ef4114","ref":"","in":"body","required":true,"desc":"Choose what signal (event) will cause the trigger to be invoked - must be one of: `post_update`, `post_create`, `post_delete`.","default":"","type":"string","name":"signal"},{"_id":"54ef49745bf74a0d00ef4115","ref":"","in":"body","required":true,"desc":"Script ID","default":"","type":"int","name":"script"},{"_id":"558c2a6bada13d0d003393e9","ref":"","in":"body","required":false,"desc":"Trigger description","default":"","type":"string","name":"description"}],"url":"/instances/:instance_name/triggers/"},"isReference":true,"order":2,"body":"Adds a Trigger.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Signals\",\n  \"body\": \"When creating a Trigger you pass a Data Class and choose which signal should invoke the Trigger:\\n- `post_create`\\n- `post_update` \\n- `post_delete`\\n\\nThey are being associated with a Data Object creation, change or deletion inside the given Data Class.\\n\\nEvery time any of those signals is invoked, the Trigger will be executed causing an associated Script to run.\\n\\nThe Script will receive the whole Data Object causing the changes inside the ARGS dictionary, regardless of whether the signal executing the Trigger was Data Object creation, change or removal.\"\n}\n[/block]","excerpt":"","slug":"triggers-add","type":"endpoint","title":"Triggers - add"}

postTriggers - add


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Body Params

label:
required
string
Trigger label
class:
required
string
Data Class name
signal:
required
string
Choose what signal (event) will cause the trigger to be invoked - must be one of: `post_update`, `post_create`, `post_delete`.
script:
required
integer
Script ID
description:
string
Trigger description

Examples


Result Format


Documentation

Adds a Trigger. [block:callout] { "type": "info", "title": "Signals", "body": "When creating a Trigger you pass a Data Class and choose which signal should invoke the Trigger:\n- `post_create`\n- `post_update` \n- `post_delete`\n\nThey are being associated with a Data Object creation, change or deletion inside the given Data Class.\n\nEvery time any of those signals is invoked, the Trigger will be executed causing an associated Script to run.\n\nThe Script will receive the whole Data Object causing the changes inside the ARGS dictionary, regardless of whether the signal executing the Trigger was Data Object creation, change or removal." } [/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 }}