Find webhooks. The authenticated user must be an administrator to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
string
string
string
returns a list of webhooks.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/webhooks' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
"pageRequest": {
"cursor": {
"reverse": true,
"cursorType": "SPACE"
},
"start": 2154,
"limit": 2154
},
"nextCursor": {
"reverse": true,
"cursorType": "SPACE"
},
"prevCursor": {
"reverse": true,
"cursorType": "SPACE"
},
"results": [
{
"scopeType": "<string>",
"events": [
"<string>"
],
"active": true,
"sslVerificationRequired": true,
"name": "<string>",
"configuration": {},
"url": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
}
}
],
"start": 25,
"limit": 25,
"next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50",
"self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25",
"prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0"
}Create a webhook via the URL. The authenticated user must be an administrator to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
the webhook to be created.
string
array<string>
boolean
boolean
string
object
string
RestWebhookCredentials
object
returns a created webhook.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl --request POST \
--url 'http://{baseurl}/confluence/rest/api/webhooks' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"scopeType": "<string>",
"events": [
"<string>"
],
"active": true,
"sslVerificationRequired": true,
"name": "<string>",
"configuration": {},
"url": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
},
"statistics": {}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"createdDate": "<string>",
"updatedDate": "<string>",
"sslVerificationRequired": true,
"events": [
{
"id": "<string>",
"i18nKey": "<string>"
}
],
"name": "<string>",
"id": 2154,
"active": true,
"configuration": {},
"scope": {
"id": "<string>",
"type": "<string>"
},
"url": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
}
}Get a webhook by id. The authenticated user must be an administrator to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredboolean
returns a webhook.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/webhooks/{webhookId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"scopeType": "<string>",
"events": [
"<string>"
],
"active": true,
"sslVerificationRequired": true,
"name": "<string>",
"configuration": {},
"url": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
}
}Update an existing webhook. The authenticated user must be an administrator to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredthe representation of the updated values for the webhook
string
array<string>
boolean
boolean
string
object
string
RestWebhookCredentials
object
returns a webhook.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl --request PUT \
--url 'http://{baseurl}/confluence/rest/api/webhooks/{webhookId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"scopeType": "<string>",
"events": [
"<string>"
],
"active": true,
"sslVerificationRequired": true,
"name": "<string>",
"configuration": {},
"url": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
},
"statistics": {}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"scopeType": "<string>",
"events": [
"<string>"
],
"active": true,
"sslVerificationRequired": true,
"name": "<string>",
"configuration": {},
"url": "<string>",
"credentials": {
"password": "<string>",
"username": "<string>"
}
}Delete a webhook via the URL. The authenticated user must be an administrator to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredreturned if deleted successfully.
1
2
curl --request DELETE \
--url 'http://{baseurl}/confluence/rest/api/webhooks/{webhookId}'Get the latest invocations for a specific webhook. The authenticated user must be an administrator to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
array<string>
returns a webhook invocation dataset.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/webhooks/{webhookId}/latest' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
"result": {
"description": "<string>",
"outcome": "ERROR"
},
"request": {
"body": "<string>",
"headers": {},
"method": "GET",
"url": "<string>"
},
"finish": "<string>",
"start": "<string>",
"eventScope": {
"id": "<string>",
"type": "<string>"
},
"id": "<string>",
"duration": {
"seconds": 2154,
"zero": true,
"nano": 2154,
"negative": true,
"units": [
{
"durationEstimated": true,
"duration": {
"seconds": 2154,
"zero": true,
"nano": 2154,
"negative": true
},
"timeBased": true,
"dateBased": true
}
]
},
"event": {
"id": "<string>",
"i18nKey": "<string>"
}
}Get the statistics for a specific webhook. The authenticated user must be an administrator to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
returns a webhook invocation dataset.
RestInvocationHistory
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/webhooks/{webhookId}/statistics' \
--header 'Accept: application/json'Get the statistics summary for a specific webhook. The authenticated user must be an administrator to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredreturns a webhook invocation dataset.
RestInvocationHistory
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/webhooks/{webhookId}/statistics/summary' \
--header 'Accept: application/json'Test connectivity to a specific endpoint. The authenticated user must be an administrator to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredreturns a webhook.
any
1
2
3
curl --request POST \
--url 'http://{baseurl}/confluence/rest/api/webhooks/test?url={url}' \
--header 'Accept: application/json'Rate this page: