| GET,POST | /subscription/test | Fire a test to one of your webhooks | |
|---|---|---|---|
| GET,POST | /subscription/test/{EventType} | Fire a test to one of your webhooks |
"use strict";
export class ApiServiceRequest {
/** @param {{ApiKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API Key required for authentication */
ApiKey;
}
export class ApiServiceResponse {
/** @param {{Description?:string,Heading?:string,WasSuccessful?:boolean,ModelState?:Object}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Description;
/** @type {string} */
Heading;
/** @type {boolean} */
WasSuccessful;
/** @type {Object} */
ModelState;
}
/** @typedef {number} */
export var WebhookSubscriptionEventType;
(function (WebhookSubscriptionEventType) {
WebhookSubscriptionEventType[WebhookSubscriptionEventType["MessageReceived"] = 1] = "MessageReceived"
})(WebhookSubscriptionEventType || (WebhookSubscriptionEventType = {}));
export class TestSubscription extends ApiServiceRequest {
/** @param {{EventType?:WebhookSubscriptionEventType,ApiKey?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {WebhookSubscriptionEventType}
* @description The event type being subscribed to */
EventType;
}
JavaScript TestSubscription DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /subscription/test HTTP/1.1
Host: galaxymobile.api.client.prod.86degrees.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<TestSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Subscription">
<ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
<EventType>MessageReceived</EventType>
</TestSubscription>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ApiServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommonService.Api.Models.Base"> <Description>String</Description> <Heading>String</Heading> <ModelState /> <WasSuccessful>false</WasSuccessful> </ApiServiceResponse>