Criar Configuração
Criar uma configuração (url que receberá os eventos) de webhook
Required scopes:webhook_write
POST
https://api.eduzz.com/webhook/v1/subscription
Body params
name
string
Nome da inscrição
url
string
URL do WebHook
events
array of object
Eventos que o WebHook irá receber
events[n].name
string
Nome do evento
filters
array of object
Filtros para os eventos
filters[n].metadata
string
Nome do filtro
filters[n].values
array of string
Valores para o filtro (sempre strings)
Response params (201)
id
string
ID da inscrição
name
string
Nome da inscrição criada
secretId
string
Id do Secret de WebHook
events
array of object
Eventos inscritos
events[n].name
string
Nome do evento
url
string
URL do WebHook
status
string
Status da inscrição
Status codes
| Status | Descrição |
| 201 | Success |
| 400 | Bad Request |
Exemplos
1curl --request POST \
2 --url 'https://api.eduzz.com/webhook/v1/subscription' \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json' \
5 --header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'\
6 --data '
7{
8 "name": "Test for Doc",
9 "url": "https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0",
10 "events": [
11 {
12 "name": "nutror.lesson_watched"
13 }
14 ],
15 "filters": [
16 {
17 "metadata": "productId",
18 "values": [
19 "123456",
20 "789012"
21 ]
22 }
23 ]
24}
25'Response
1{
2 "name": "Test for Doc",
3 "url": "https://webhook.site/c8ff7d31-4fd9-40c7-8eca-b2334d996fb0",
4 "secretId": "87fce2b9bbbf534fc91fa63fdb697a4e9b7f17205c2577ef2cb1f9757307c180",
5 "events": [
6 {
7 "name": "nutror.lesson_watched"
8 }
9 ],
10 "status": "disabled",
11 "id": "yaeung4oaxt25pi0bzzycoezf"
12}