{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"DrillPlan External Event API","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"drillplan-external-event-api","__idx":0},"children":["DrillPlan External Event API"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"introduction","__idx":1},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["DrillPlan's External Event API allows external applications send general messages to DrillPlan."]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["Example cURL ",{"$$mdtype":"Tag","name":"span","attributes":{"style":{"color":"#49CC90"}},"children":["POST"]}," Request ",{"$$mdtype":"Tag","name":"small","attributes":{},"children":["(click to open)"]}]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"curl","header":{"controls":{"copy":{}}},"source":"curl -X POST '{baseURL}external-event/v1/external-events'\n-H 'accept: application/json' \\\n-H 'slb-partition-id: {SlbPartitionId}' \\\n-H 'appkey: {appKey}' \\\n-H 'Content-Type: application/json' \\\n-H 'Authorization: Bearer {token}' \\\n-d '{\n    \"projectId\": \"\", \n    \"planId\": \"\", \n    \"status\": \"Success\", \n    \"title\": \"Mesage title\", \n    \"content\": \"Message content\", \n    \"sender\": \"SENDER\"\n}'\n","lang":"curl"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"post-body","__idx":2},"children":["Post body"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"projectid","__idx":3},"children":["projectId"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The project id is optional, when specified, it should be a valid DrillPlan project ID."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"planid","__idx":4},"children":["planId"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The planId is optional, when specified, it should be a valid DrillPlan plan ID."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message scope"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If neither projectId nor planId specified, the event scope will be data partition level, all users under the given data partition will receive the event."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If only projectId is specified, the event scope will be project level. Users who joined the project will receive the event."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If only planId is specified, the event scope will be project level. The project will be matched by the given plan id. Users who joined the plan will receive the event."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If both ids are specified, it will be the same behavior to the previous condition."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"status","__idx":5},"children":["status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The status should be one of [Success, Warning, Error], request with an invalid status will get a 400 response with validation error message. External event panel in DrillPlan will display different icons depends on the status."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"title","__idx":6},"children":["title"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The title should be as concise as possible, details could be elaborated in the content field. This property can't be empty."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"sender","__idx":7},"children":["sender"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The sender is normally the name of external system. This property can't be empty."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"content","__idx":8},"children":["content"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The content property uses Markdown format, supporting bold, italic, lists, and links. The content needs to be composed to a single line string, use '\\n\\n' for line breaks."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example, if the content want to display in DrillPlan UI like below:"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example content with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["bold"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["italic"]},", lists and link."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ordered:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Item O1"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Item O2"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unordered:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Item U1"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Item U2"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["End of message with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://url"},"children":["Link text"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The content should be:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Example content with **bold** *italic*, lists and link. \\n\\n Ordered: \\n\\n 1. Item O1 \\n\\n 2. Item O2 \\n\\n Unordered: \\n\\n - Item U1 \\n\\n - Item U2 \\n\\n End of message with [Link text](https://url). "]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This property can be empty."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"throttling","__idx":9},"children":["Throttling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The external event api has throttling control, the request can be execute per 5 seconds."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"data-persistance","__idx":10},"children":["Data persistance"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each POST request creates a new record in its data partition. The maximum number of records allowed in each data partition is 1,000. When the 1,001st record needs to be created, the earliest record will be deleted."]}]},"headings":[{"value":"DrillPlan External Event API","id":"drillplan-external-event-api","depth":2},{"value":"Introduction","id":"introduction","depth":3},{"value":"Post body","id":"post-body","depth":3},{"value":"projectId","id":"projectid","depth":4},{"value":"planId","id":"planid","depth":4},{"value":"status","id":"status","depth":4},{"value":"title","id":"title","depth":4},{"value":"sender","id":"sender","depth":4},{"value":"content","id":"content","depth":4},{"value":"Throttling","id":"throttling","depth":3},{"value":"Data persistance","id":"data-persistance","depth":3}],"frontmatter":{"seo":{"title":"DrillPlan External Event API"}},"lastModified":"2026-01-20T06:16:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/drillplan/docs/tutorials/api-consumption-guide/external-event-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}