Skip to main content
Browse Documentation
HTTP - Management

List Webhook Subscriptions

Created by c.neale, last modified by zengenti on 25 Nov 2020

A list of webhook subscriptions can be retrieved by sending a GET request to the webhook subscriptions resource collection without specifying a subscription ID.

GET/api/management/projects/{projectId}/events/webhooks/subscriptions

Parameter

NameParameter typeTypeDescriptionExampleRequired
projectIdpathstringThe project identifier found in the project overview screen of the management consolemovieDbtrue

Examples

Get a list webhook subscriptions

GET: /api/management/projects/movies/events/webhooks/subscriptions

Example response

HTTP Status: 200 OK

[
    {
        "id": "0a37d5dd-9408-461d-b09c-3e63d6acfbba",
        "name": {
            "en-GB": "b.g.kahn"
        },
        "description": {
            "en-GB": "Some updated description"
        },
        "url": "https://mywebservice.com/eventhandler",
        "enabled": true,
        "topics": [
            {
                "resourceType": "entry",
                "event": [
                    "created"
                ],
                "contentTypeId": [
                    "blog"
                ],
                "language": [
                    "en-GB"
                ],
                "owner": "t.durden"
            },
            {
                "resourceType": "entry",
                "event": [
                    "updated"
                ],
                "contentTypeId": [
                    "blog"
                ],
                "language": [
                    "en-GB"
                ],
                "owner": "t.durden"
            },
            {
                "resourceType": "contentType",
                "event": [
                    "created"
                ]
            }
        ],
        "templates": {},
        "headers": {},
        "version": {
            "createdBy": "stub user",
            "created": "2020-11-25T09:49:36.568912Z",
            "modifiedBy": "stub user",
            "modified": "2020-11-25T09:53:49.9189103Z",
            "versionNo": "2.0"
        }
    },
    {
        "id": "7498c002-63c0-4238-bc1d-76c61b40ada1",
        "name": {
            "en-GB": "a.dent"
        },
        "description": null,
        "url": "https://mywebservice.com/eventhandler",
        "enabled": true,
        "topics": [
            {
                "resourceType": "entry",
                "event": [
                    "created"
                ],
                "contentTypeId": [
                    "blog"
                ],
                "language": [
                    "en-GB"
                ],
                "owner": "t.durden"
            },
            {
                "resourceType": "entry",
                "event": [
                    "updated"
                ],
                "contentTypeId": [
                    "blog"
                ],
                "language": [
                    "en-GB"
                ],
                "owner": "t.durden"
            },
            {
                "resourceType": "contentType",
                "event": [
                    "created"
                ]
            }
        ],
        "templates": {},
        "headers": {},
        "version": {
            "createdBy": "stub user",
            "created": "2020-11-25T09:59:06.2106119Z",
            "modifiedBy": null,
            "modified": null,
            "versionNo": "1.0"
        }
    },
    {
        "id": "8dd1ca3d-df66-464f-9bab-162e5c312fbe",
        "name": {
            "en-GB": "d.a.lincoln"
        },
        "description": {
            "en-GB": "Some other description"
        },
        "url": "https://mywebservice.com/eventhandler",
        "enabled": true,
        "topics": [
            {
                "resourceType": "entry",
                "event": [
                    "created"
                ],
                "contentTypeId": [
                    "blog"
                ],
                "language": [
                    "en-GB"
                ],
                "owner": "t.durden"
            },
            {
                "resourceType": "entry",
                "event": [
                    "updated"
                ],
                "contentTypeId": [
                    "blog"
                ],
                "language": [
                    "en-GB"
                ],
                "owner": "t.durden"
            },
            {
                "resourceType": "contentType",
                "event": [
                    "created"
                ]
            }
        ],
        "templates": {},
        "headers": {},
        "version": {
            "createdBy": "stub user",
            "created": "2020-11-25T09:58:20.6891858Z",
            "modifiedBy": null,
            "modified": null,
            "versionNo": "1.0"
        }
    },
    {
        "id": "a8badd75-37ef-40c3-ae0f-3a9881165595",
        "name": {
            "en-GB": "b.g.kahn"
        },
        "description": {
            "en-GB": "Some description"
        },
        "url": "https://mywebservice.com/eventhandler",
        "enabled": true,
        "topics": [
            {
                "resourceType": "entry",
                "event": [
                    "created"
                ],
                "contentTypeId": [
                    "blog"
                ],
                "language": [
                    "en-GB"
                ],
                "owner": "t.durden"
            },
            {
                "resourceType": "entry",
                "event": [
                    "updated"
                ],
                "contentTypeId": [
                    "blog"
                ],
                "language": [
                    "en-GB"
                ],
                "owner": "t.durden"
            },
            {
                "resourceType": "contentType",
                "event": [
                    "created"
                ]
            }
        ],
        "templates": {},
        "headers": {},
        "version": {
            "createdBy": "stub user",
            "created": "2020-11-25T09:32:03.9902377Z",
            "modifiedBy": null,
            "modified": null,
            "versionNo": "1.0"
        }
    }
]

Responses

HTTP status codeReasonModel
200SuccessPagedList<Webhook Subscription>
500Internal server errorError