Skip to content

Commit d6ed770

Browse files
authored
Merge pull request #12 from circuit/develop-incomingwebhooks
updating documentation to remove any mention of markdown formatting
2 parents 8276e73 + cf81492 commit d6ed770

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

webhooks.html

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,34 @@ <h1>Circuit Webhooks</h1>
5656
<li>Open the sidebar and click on add an app or the + button</li>
5757
<li>Name your incoming webhook and click on Create</li>
5858
<li>>You will get the incoming webhook URL, copy it to clipboard</li>
59-
<li>You can post to Circuit using this URL <br> <code>curl --insecure -X POST https://yourcircuit.com/rest/v2/webhooks/incoming/1234392e25a0c-c88f-4eab-a27e-f88ccd657d17 -d '{"text": "*bold* `code` _italic_ ~strike~"}'</code></li>
59+
<li>You can post to Circuit using this URL <br> <code>curl --insecure -X POST https://yourcircuit.com/rest/v2/webhooks/incoming/1234392e25a0c-c88f-4eab-a27e-f88ccd657d17 -d '{"text": "This is the content of my post"}'</code></li>
6060
</ol>
6161
</p>
6262

63+
<p>
64+
<strong>Formatting</strong>
65+
<code>
66+
<xmp>
67+
json
68+
{
69+
"text": "<b>bold</b> <i>italic</i>"
70+
}
71+
</xmp>
72+
</code>
73+
<br>
74+
Circuit supports bold, italic and highlited texts. It supports line breaks and ordered and lists with bullet points and numbered items. See the code below for examples :
75+
<code>
76+
<xmp>
77+
78+
json
79+
{
80+
"text" : "Circuit supports <span class='rich-text-highlight'>highlighted text</span> and <br> line breaks.
81+
It also supports bullet lists and numbered lists with <ul><li>item1</li><li>item2</li></ul> and ><ol><li>item1</li><li>item2</li></ol>."
82+
}
83+
</xmp>
84+
</code>
85+
</p>
86+
6387
<p>
6488
<strong>Example</strong> <br>
6589
<code>circuit-call-me-button</code> <br>

0 commit comments

Comments
 (0)