Webhook

Naas.ai GitHub Slack Community What's new?
Search…
⚙
Webhook
Run a notebook by calling an URL.
Add
Send in production this notebook and get URL to run it when opened.
​
1
naas.webhook.add()
Copied!
screenshot-api-add
Other files
You can also give a path to the function and that will deploy this one instead of the current one.
1
naas.webhook.add(path="path/to/my/super/notebook.ipynb")
Copied!
Parameters
notif_down : Receive an email when the notebook run fails.
notif_up : Receive an email when the notebook runs well.
next_url : Redirect users to another URL after the notebook is run.
inline : Get a response in your web browser instead of downloading the result.
1
params = {"notif_down": "[email protected]", "notif_up": "[email protected]"}
2
​
3
naas.webhook.add(params=params)
Copied!
Dynamic Parameters
When you notebook url is called in getting  or post, it accepts parameters with mime-type :
application/x-www-form-urlencoded
application/json
They will be injected into a new cell in the first position in your notebook.
If You want them to be added at a specific place add tag parameters in a cell and your dynamic parameters will be added in a new cell next to it.

Example of params
In this screenshot below, you can see variables from our notebook in the first cell, and in the second cell, the dynamic parameters injected.
Debug
Need to understand why somethings go bad?
1
naas.webhook.add(debug=True)
Copied!
Response
Run a Notebook by API is not enough, you can return a result :
Html
Send back any HTML payload.
Don't be a fool and put Facebook code source here, the idea is to stay simple!
1
naas.webhook.respond_html("<h1>Check my super html !</h1>")
Copied!
To confirm that is well loaded you should see it in the cell output.
JSON
1
naas.webhook.respond_json({"foo": "bar"})
Copied!
Image
1
import requests
2
​
3
url = "https://picsum.photos/id/237/200/300"
4
​
5
naas.webhook.respond_image(requests.get(url, stream=True).content)
Copied!
SVG
1
# Exemple Svg
2
jupyterlogo = '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Jupyter icon</title><path d="M7.157 22.201A1.784 1.799 0 0 1 5.374 24a1.784 1.799 0 0 1-1.784-1.799 1.784 1.799 0 0 1 1.784-1.799 1.784 1.799 0 0 1 1.783 1.799zM20.582 1.427a1.415 1.427 0 0 1-1.415 1.428 1.415 1.427 0 0 1-1.416-1.428A1.415 1.427 0 0 1 19.167 0a1.415 1.427 0 0 1 1.415 1.427zM4.992 3.336A1.047 1.056 0 0 1 3.946 4.39a1.047 1.056 0 0 1-1.047-1.055A1.047 1.056 0 0 1 3.946 2.28a1.047 1.056 0 0 1 1.046 1.056zm7.336 1.517c3.769 0 7.06 1.38 8.768 3.424a9.363 9.363 0 0 0-3.393-4.547 9.238 9.238 0 0 0-5.377-1.728A9.238 9.238 0 0 0 6.95 3.73a9.363 9.363 0 0 0-3.394 4.547c1.713-2.04 5.004-3.424 8.772-3.424zm.001 13.295c-3.768 0-7.06-1.381-8.768-3.425a9.363 9.363 0 0 0 3.394 4.547A9.238 9.238 0 0 0 12.33 21a9.238 9.238 0 0 0 5.377-1.729 9.363 9.363 0 0 0 3.393-4.547c-1.712 2.044-5.003 3.425-8.772 3.425Z"/></svg>'
3
​
4
naas.webhook.respond_svg(jupyterlogo)
Copied!
Text
1
# Exemple text
2
text = "Hello Naas friends, do you love markdown as us ?"
3
​
4
naas.webhook.respond_text(markdown_text)
Copied!
Markdown
1
# Exemple MD
2
markdown_text = "# Hello Naas friends<br /> Do you love markdown as us ?"
3
​
4
naas.webhook.respond_markdown(markdown_text)
Copied!
CSV
Again, this is not intended to host a 6Go CSV file, it will break your notebook and you will lose access to it, use the "File" option instead.
1
# Exemple Csv
2
csv_text = ```
3
Sally Whittaker,2018,McCarren House,312,3.75
4
Belinda Jameson,2017,Cushing House,148,3.52
5
Jeff Smith,2018,Prescott House,17-D,3.20
6
Sandy Allen,2019,Oliver House,108,3.48
7
```
8
​
9
naas.webhook.respond_csv(csv_text)
Copied!
File
Send big file not embed in the notebook :
1
naas.webhook.respond_file("test.csv")
Copied!
If your file is not generated by a notebook, add it as Dependency, otherwise, it will be missing in the production folder.
Notebook
 Respond the notebook output with:
1
naas.webhook.respond_notebook()
Copied!
Find 
You can find URL of a file pushed into the production:
Current file
1
url = naas.webhook.find()
Copied!
Other files 
1
url = naas.webhook.find(path="path/to/my/super/notebook.ipynb")
Copied!
List 
You can list all version of a file pushed into the production:
Current file
1
naas.webhook.list()
Copied!
Other files 
1
naas.webhook.list(path="path/to/my/super/notebook.ipynb")
Copied!
Get 
You can get a version of a file pushed into the production:
Get the last one
1
naas.webhook.get()
Copied!
With a file path
1
naas.webhook.get(path="path/to/my/super/notebook.ipynb")
Copied!
With history id
1
naas.webhook.get(histo="20201008101221879662")
Copied!
Combined
1
naas.webhook.get(path="path/to/my/super/notebook.ipynb", histo="20201008101221879662")
Copied!
Clear
You can clear the previous version of a file pushed into the production:
One
1
naas.webhook.clear(histo="20201008101221879662")
Copied!
Other Notebook
1
naas.webhook.clear(path="path/to/my/super/notebook.ipynb", histo="20201008101221879662")
Copied!
All
1
naas.webhook.clear()
Copied!
All for filepath
1
naas.webhook.clear(path="path/to/my/super/notebook.ipynb")
Copied!
Get output
You can get the output of the production file:
Get the last one
1
naas.webhook.get_output()
Copied!
With a file path
1
naas.webhook.get_output(path="path/to/my/super/notebook.ipynb")
Copied!
Clear output
You can clear the previous output of a file pushed into the production:
One
1
naas.webhook.clear_output()
Copied!
Other Notebook
1
naas.webhook.clear_output(path="path/to/my/super/notebook.ipynb")
Copied!
Delete
You can remove any scheduler capability like that, it takes optionally a path. 
Current
1
naas.webhook.delete()
Copied!
Other file
1
naas.webhook.delete(path="path/to/my/super/notebook.ipynb")
Copied!
Debug
1
naas.webhook.delete(debug=True)
Copied!
List APIs
You don't remember how many API notebooks you have?
Simple
1
naas.webhook.currents()
Copied!
Raw result 
1
naas.webhook.currents(raw=True)
Copied!
​
Scheduler
Asset
Last modified 4mo ago