Delete Webhook

Service Name	Unregister Webhook
Service Type	REST
Method	DELETE
UAT (Sandbox) URL	https://integration.uat.marley.ai/webhooks/unregister/:subscriptionId
Production URL	https://integration.himarley.io/webhooks/unregister/:subscriptionId
Technical Documentation	API Endpoint - Postman Collection

This API will allow you to delete/unregister a Webhook Subscription from 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 and pass the Subscription ID of the Webhook you'd like to unsubscribe.

Validation Flow 

1. Subscription ID passed is currently registered to your Org.

Request Example

https://integration.uat.marley.ai/webhooks/unregister/cbad0db4-c148-4673-8299-a68b5802d949

API Response

Response Example

{
    "SUBSCRIPTION_ID": "cbad0db4-c148-4673-8299-a68b5802d949",
    "EVENT": "MESSAGE",
    "ORGANIZATION_ID": "1d2f4e68-d733-477f-acc4-c1c187f0c159",
    "REGISTERED_PAYLOAD": {
        "EVENT_ID": 14,
        "HTTP_POST_ADDRESS": "https://webhook.site/2c958d8d-7763-4db0-b423-8edbb384b023/himarley/api/v1/userObject/opt-in"
    }
}

 

Response Fields Breakdown

Property	Element	Description	Type	Required	Example
SUBSCRIPTION_ID		The unique UUID assigned to the subscription at registration.	string	true	"SUBSCRIPTION_ID":"cbad0db4-c148-4673-8299-a68b5802d949"
EVENT		The Hi Marley Event.	enum	true	"EVENT": "MESSAGE"
ORGANIZATION_ID		The unique UUID assigned to the Organization at registration.	string	true	"ORGANIZATION_ID": "1d2f4e68-d733-477f-acc4-c1c187f0c159"
REGISTERED_PAYLOAD	EVENT_ID	The Hi Marley ID associated to the Event.	int	true	"EVENT_ID": 14
	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
• Get Webhook Subscriptions