HTTP - Management

Get a webhook subscription

Created by c.neale, last modified by zengenti on 07 Apr 2021

A webhook subscription resource can be retrieved by sending a GET request to the webhook subscriptions resource collection for the specific subscription ID.

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

Parameters

Name	Parameter type	Type	Format	Description	Example	Required
projectId	path	string		The project identifier found in the project overview screen of the management console	movieDb	true
subscriptionId	path	string	uuid	The unique identifier of the subscription		true

Examples

Get a specific webhook subscription.

GET: /api/management/projects/movies/events/webhooks/subscriptions/0a37d5dd-9408-461d-b09c-3e63d6acfbba

Example response

HTTP Status: 200 OK

{
    "id": "0a37d5dd-9408-461d-b09c-3e63d6acfbba",
    "name": "b.g.kahn",
    "description":  "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"
    }
}

Responses

HTTP status code	Reason	Model
200	Success	Webhook Subscription
404	Subscription not found	Error
500	Internal server error	Error