{"id":12492,"date":"2022-11-17T06:36:15","date_gmt":"2022-11-17T06:36:15","guid":{"rendered":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/?post_type=article&#038;p=12492"},"modified":"2025-09-25T16:17:48","modified_gmt":"2025-09-25T10:47:48","slug":"webhooks","status":"publish","type":"article","link":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/article\/webhooks\/","title":{"rendered":"Webhooks"},"content":{"rendered":"<p><img loading=\"lazy\" decoding=\"async\" class=\"aligncenter size-full wp-image-15936\" src=\"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Nimble-Webhooks.jpg\" alt=\"Webhooks\" width=\"2506\" height=\"472\" srcset=\"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Nimble-Webhooks.jpg 2506w, https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Nimble-Webhooks-300x57.jpg 300w, https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Nimble-Webhooks-1024x193.jpg 1024w, https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Nimble-Webhooks-768x145.jpg 768w, https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Nimble-Webhooks-1536x289.jpg 1536w, https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Nimble-Webhooks-2048x386.jpg 2048w\" sizes=\"(max-width: 2506px) 100vw, 2506px\" \/><\/p>\n<p>Webhooks can be used to notify changes in Nimble cards or user data to other tools and applications. When a specific event occurs in the Nimble, a webhook message is sent to a predefined third-party URL, delivering real-time information about that event, and data it changed, to the specified tool.<\/p>\n<p>Using webhooks, you can create any number of scenarios in which Nimble communicates directly with a specific tool whenever an event occurs in a project.<\/p>\n<p>Please note that only the enterprise creator and organization admin have access at the administration level, whereas only the project manager and team lead have access at the project level.<\/p>\n<h2>Navigation<a id=\"Webhook\"><\/a><a id=\"Navigation\"><\/a><\/h2>\n<p><em>Project Level &#8211;<\/em> Navigate to the breadcrumb at the top hover over the Project name, expand the <strong>Setup<\/strong> module, and select <strong>Webhooks. OR<\/strong><\/p>\n<p><em>Administration Level &#8211;<\/em> In the left navigation panel, expand the <strong>Apps<\/strong> menu and select the <strong>Account Space<\/strong>. Hover over the top breadcrumb, expand the <strong>Administration<\/strong>\u00a0module, and select\u00a0<strong>Webhooks<\/strong>.<a id=\"Layout\"><\/a><\/p>\n<h2>Create Webhook<\/h2>\n<p>Go to your destination (specified) tool and prepare the URL that Nimble will use before creating a webhook. This URL will then be used to create a webhook.<\/p>\n<ol>\n<li>Click the <strong>ADD<\/strong> button.<\/li>\n<li>Enter a <strong>Name\u00a0<\/strong>identifying the webhook.<\/li>\n<li>Enter or paste the payload <strong>URL<\/strong> to post the information that will be called when the webhook is triggered.<\/li>\n<li>You can optionally specify a secret token if such a token-based validation mechanism is supported by the receiver.(Optional)<\/li>\n<li>Enter the <strong>Description<\/strong> to further identify the intent of the webhook. (Optional)<\/li>\n<li><strong>Enable<\/strong> to make the webhook active, or <strong>Disable<\/strong> to make it inactive.<\/li>\n<li>Check the <strong>Box\u00a0<\/strong>if only the action of the event needs to be sent, not the card details.<\/li>\n<li>In the <strong>Card Type<\/strong> section, select the required card type that will trigger the selected event.<\/li>\n<li>In the <strong>Event Triggers<\/strong> section, select the required events of the cards that will trigger sending your new webhook.<\/li>\n<li>Click the <strong>SAVE<\/strong> button. The new webhook will be stored, and then create a Webhook dialog will close.<a id=\"EditWebhook\"><\/a><\/li>\n<\/ol>\n<p>The new webhook will now be shown in the <strong>Webhooks<\/strong> List.<\/p>\n<p><a href=\"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Webhook-scaled.jpg\"><img loading=\"lazy\" decoding=\"async\" class=\"alignleft size-full wp-image-13486\" src=\"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Webhook-scaled.jpg\" alt=\"\" width=\"2560\" height=\"1441\" srcset=\"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Webhook-scaled.jpg 2560w, https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Webhook-300x169.jpg 300w, https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Webhook-1024x576.jpg 1024w, https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Webhook-768x432.jpg 768w, https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Webhook-1536x865.jpg 1536w, https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-content\/uploads\/2022\/11\/Webhook-2048x1153.jpg 2048w\" sizes=\"(max-width: 2560px) 100vw, 2560px\" \/><\/a><\/p>\n<h2>View and Edit Webhook<\/h2>\n<ol>\n<li>To view and edit a specific webhook, hover on the required webhook and then click the <strong>Edit<\/strong> button. The webhook details will appear.<\/li>\n<li>Make the desired changes to the selected webhook.<a id=\"WebhookExample\"><\/a><\/li>\n<li>Click the <strong>SAVE<\/strong> button to save the webhook Or the <strong>DELETE<\/strong> button to delete it.<\/li>\n<\/ol>\n<h2>Example of Webhook Response<\/h2>\n<p>Every Webhook sent to your endpoint will have an event field in its body. This field will contain the payload with the event&#8217;s data (card details).<\/p>\n<pre class=\"brush: xml; title: ; notranslate\" title=\"\">\r\n{\r\n&quot;event&quot;: {\r\n&quot;realmId&quot;: &quot;NIMBLEQA&quot;,\r\n&quot;accountId&quot;: &quot;70051025&quot;,\r\n&quot;ownerType&quot;: &quot;Org&quot;,\r\n&quot;ownerId&quot;: &quot;70051526&quot;,\r\n&quot;itemType&quot;: &quot;PREQ&quot;,\r\n&quot;itemId&quot;: &quot;70051021&quot;,\r\n&quot;userId&quot;: &quot;70052143&quot;,\r\n&quot;app&quot;: &quot;nimble&quot;,\r\n&quot;entity&quot;: &quot;com.Robinson.cloud.nimble.EForm&quot;,\r\n&quot;eventName&quot;: &quot;addEForm&quot;,\r\n&quot;entityVersion&quot;: &quot;1&quot;,\r\n&quot;apiVersion&quot;: &quot;v1&quot;\r\n},\r\n&quot;content&quot;: {\r\n&quot;CM_Priority&quot;: &quot;--None--&quot;,\r\n&quot;CREATEPROJECT&quot;: &quot;Y&quot;,\r\n&quot;Category&quot;: &quot;--None--&quot;,\r\n&quot;STARTDATE&quot;: &quot;2022-11-29T00:00:00Z&quot;,\r\n&quot;PROCESSTEMPLATE&quot;: &quot;--None--&quot;,\r\n&quot;CM_Description&quot;: &quot;null&quot;,\r\n&quot;PreqCategory&quot;: &quot;--None--&quot;,\r\n&quot;ISAGILE&quot;: &quot;Y&quot;,\r\n&quot;CM_CreationDate&quot;: &quot;2022-11-29T12:04:50Z&quot;,\r\n&quot;CM_CreatedBy&quot;: &quot;70052143&quot;,\r\n&quot;CM_OverallStatus&quot;: &quot;Open&quot;,\r\n&quot;CM_DUEDATE&quot;: &quot;&quot;,\r\n&quot;TASK_ACT_TRACKING_MODE&quot;: &quot;Timesheet&quot;,\r\n&quot;PROJECTMANAGER&quot;: &quot;70052143&quot;,\r\n&quot;TRACEDPROJECT&quot;: &quot;&quot;,\r\n&quot;EFORM_INSTANCE_ITEMID&quot;: &quot;70051021&quot;,\r\n&quot;TRACKINGBY&quot;: &quot;PC&quot;,\r\n&quot;PROJECTLEVEL&quot;: &quot;--None--&quot;,\r\n&quot;CM_CurrentStageName&quot;: &quot;&quot;,\r\n&quot;CM_Name&quot;: &quot;olddemand&quot;,\r\n&quot;WBSORDERBY&quot;: &quot;--None--&quot;,\r\n&quot;CM_ItemCode&quot;: &quot;PREQ1&quot;,\r\n&quot;PROJECTTYPE&quot;: &quot;--None--&quot;,\r\n&quot;ENDDATE&quot;: &quot;2023-09-29T00:00:00Z&quot;,\r\n&quot;FinancialTemplate&quot;: &quot;--None--&quot;,\r\n&quot;PROJECTCODE&quot;: &quot;DEM000004&quot;,\r\n&quot;TASKMODULE&quot;: &quot;STaRT Plus&quot;,\r\n&quot;CM_SeqNumber&quot;: &quot;1&quot;\r\n}\r\n}\r\n<\/pre>\n<div class=\"helpful-block-content wth-theme-thumbs\" data-title=\"\" >\n<ul>\n<li><span class=\"wth-title\">Was this helpful?<\/span><\/li>\n<li><a data-post=\"12492\" data-post-url=\"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/article\/webhooks\/\" data-post-title=\"Webhooks\" data-response=\"1\" href=\"#\" class=\"wth-green-btn icon-thumbsup\">Yes<\/a>&nbsp; &nbsp;<a data-response=\"0\" data-post=\"12492\" data-post-url=\"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/article\/webhooks\/\" data-post-title=\"Webhooks\" href=\"#\" class=\"wth-red-btn icon-thumbsdown\">No<\/a><\/li>\n<\/ul>\n<\/div>","protected":false},"author":1,"featured_media":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","multi-rating":{"mr_rating_results":[]},"_links":{"self":[{"href":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-json\/wp\/v2\/article\/12492"}],"collection":[{"href":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-json\/wp\/v2\/article"}],"about":[{"href":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-json\/wp\/v2\/types\/article"}],"author":[{"embeddable":true,"href":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-json\/wp\/v2\/comments?post=12492"}],"version-history":[{"count":111,"href":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-json\/wp\/v2\/article\/12492\/revisions"}],"predecessor-version":[{"id":22240,"href":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-json\/wp\/v2\/article\/12492\/revisions\/22240"}],"wp:attachment":[{"href":"https:\/\/www.nimblework.com\/knowledge-base\/nimble\/wp-json\/wp\/v2\/media?parent=12492"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}