Get Webhook Subscriptions

Service Name	View Subscribed Webhooks
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/webhooks/subscribed
Production URL	https://integration.himarley.io/webhooks/subscribed
Technical Documentation	API Endpoint - Postman Collection

This Get API will return all currently subscribed webhooks to your Org.

Table of Contents

• API Request
  • Flow
  • Validation Flow
  • Request Example
• API Response
  • Response Example
  • Response Fields Breakdown
• Related Articles

API Request

Flow

1. Call the endpoint with your API key.  There is no Path Parameters or Body that is passed with this request.

Validation Flow 

1. API key is valid.

Request Example

https://integration.uat.marley.ai/webhooks/subscribed

API Response

Response Example

{
   {
        "EVENT": "CASE_REASSIGNED",
        "SUBSCRIPTION_ID": "1afea0ef-79d5-4adb-bc5f-985a11eaa4d3",
        "REGISTERED_PAYLOAD": {
            "EVENT_ID": 21,
            "HTTP_POST_ADDRESS": "https://webhook.site/2354f162-de12-40b7-8ad5-29b5d80216b3"
        }
    },
{
        "EVENT": "MESSAGE",
        "SUBSCRIPTION_ID": "b16d46aa-2c4a-47a9-8e18-3fb6072ebb8d",
        "REGISTERED_PAYLOAD": {
            "EVENT_ID": 14,
            "HTTP_POST_ADDRESS": "https://webhook.site/7a08bf12-1faa-4790-81c4-2ba9f6bfaac8",
            "HEADERS": {
                "env": "uat-hm",
                "event": "message"
            },
            "includeMessageClassifications": true
        }
    }

 

Response Fields Breakdown

Property	Element	Description	Type	Required	Example
EVENT		The Hi Marley Event.	enum	true	"EVENT": "CASE_REASSIGNED"
SUBSCRIPTION_ID		The unique UUID assigned to the subscription at registration.	string	true	"SUBSCRIPTION_ID": "1afea0ef-79d5-4adb-bc5f-985a11eaa4d3"
REGISTERED_PAYLOAD	EVENT_ID	The Hi Marley ID associated to the Event.	int	true	"EVENT_ID": 21
	HTTP_POST_ADDRESS	The HTTP Address to post the Event Payload to.	string	true	"HTTP_POST_ADDRESS": "https://webhook.site/2354f162-de12-40b7-8ad5-29b5d80216b3
	HEADERS	This element will return any headers that were added as part of the initial webhook subscription.	string	true	Headers are dynamic and can be defined upon description to whatever you'd like.

Related Articles

• Webhooks Overview
• Webhook Guides