| Info |
|---|
For sending this request, you have to be authorized. See the API Authorization page for more details. |
Use this request to list all your active webhook configurations.
Request
| Code Block | ||
|---|---|---|
| ||
curl -X GET https://rest.doo.net/v1/team/<team_id>/webhooks \ -H 'Content-Type: application/json' \ -H 'x-api-key: <api_key>' \ -H 'Authorization: Bearer <access_token>' |
...
Parameter | Required | Description |
|---|---|---|
| Yes | The ID of the webhook configurationTeam ID for which you want to list the webhooks. See Get all organizations and teams to figure out the Team ID. |
| Yes | see API See Authorization |
| Yes | see API See Authorization |
Response
...
Example 1 - standard webhook
| Code Block |
|---|
{
"_links": {
"self": {
"href": "https://rest.doo.net/team/<team_id>/webhooks?page=1"
},
"first": {
"href": "https://rest.doo.net/team/<team_id>/webhooks"
},
"last": {
"href": "https://rest.doo.net/team/<team_id>/webhooks?page=1"
}
},
"_embedded": {
"webhooks": [
{
"id": "38cc7e8d-d107-11e7-bde8-0206116776d1",
"name": "My Test Webhook",
"description": "",
"hooks": [
{
"type": "event_created",
"method": "POST",
"endpoint": "https://company.com/receive-doo-webhooks"
},
{
"type": "event_removed",
"method": "POST",
"endpoint": "https://company.com/receive-doo-webhooks"
},
{
"type": "event_updated",
"method": "POST",
"endpoint": "https://company.com/receive-doo-webhooks"
},
{
"type": "order_created",
"method": "POST",
"endpoint": "https://company.com/receive-doo-webhooks"
},
{
"type": "order_removed",
"method": "POST",
"endpoint": "https://company.com/receive-doo-webhooks"
},
{
"type": "order_updated",
"method": "POST",
"endpoint": "https://company.com/receive-doo-webhooks"
},
{
"type": "order_cancelled",
"method": "POST",
"endpoint": "https://company.com/receive-doo-webhooks"
}
],
"authentication": {
"grant_type": "client_credentials",
"endpoint": "https://company.com/authorize-doo-webhooks",
"credentials": {
"client_id": "doo",
"client_secret": "super-strong-secret"
},
"header_format": "Authorization",
"header_value_format": "Bearer %ACCESS_TOKEN%"
},
"_links": {
"self": {
"href": "https://rest.doo.net/v1/webhooks/38cc7e8d-d107-11e7-bde8-0206116776d1"
}
}
}
]
},
"page_count": 1,
"page_size": 25,
"total_items": 5,
"page": 1
} |
Example 2 - GraphQL webhook
...
example
| Code Block | ||
|---|---|---|
| ||
{
"_links": {
"self": {
"href": "https://apirest.staging1.doo.net/v1/team/<team_id>111/webhooks?page=1"
},
"first": {
"href": "https://api.staging1rest.doo.net/v1/team/<team_id>111/webhooks"
},
"last": {
"href": "https://apirest.staging1.doo.net/v1/team/<team_id>111/webhooks?page=1"
}
},
"_embedded": {
"webhooks": [
{
"id": "04266663-6684-a883-66b2-cfa3e7572d3312",
"name": "MyTest GraphQL Webhookwebhook",
"description": "WebhookEvent forcreation testingand hookupdates types with GraphQL bodywebhook subscription",
"hooks": [
{
"type": "event_created_92bd9a53281981160c955e339304b3e5",
"method": "POST",
"endpoint": "https://company.com/receive-doo-webhooks",
"origin": {
"method": "POST",
"endpoint": "https://gql.doo.net",
"body": "{\"operationName\":\"EventCreatedShort\",\"variables\":{\"id\":\"%EVENT_ID%\"},\"query\":\"query EventCreatedShort($id: ID!) {\\n event(id: $id) {\\n title\\n }\\n}\\n\"}"
}
},
{
"type": "event_updated_2104384af7e8434f0058ed57163b6f33",
"method": "POST",
"endpoint": "https://company.com/receive-doo-webhooks",
"origin": {
"method": "POST",
"endpoint": "https://gql.doo.net",
"body": "{\"operationName\":\"EventUpdatedShort\",\"variables\":{\"id\":\"%EVENT_ID%\"},\"query\":\"query EventUpdatedShort($id: ID!) {\\n event(id: $id) {\\n title\\n }\\n}\\n\"}"
}
}
],
"authentication": {
"grant_type": "client_credentials",
"endpoint": "https://company.com/authorize-doo-webhooks",
"credentials": {
"client_id": "doo",
"client_secret": "super-strong-secret"
},
"header_format": "Authorization",
"header_value_format": "Bearer %ACCESS_TOKEN%"
},
"_links": {
"self": {
"href": "https://api.staging1rest.doo.net/v1/team/<team_id>/webhooks"
}
}
}
]
},
"page_count": 1,
"page_size": 7,
"total_items": 1,
"page": 1
} |