| 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 |
export class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
/** @description The API Key required for authentication */
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
public ApiKey: string;
public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}
export class ApiServiceResponse implements IServiceResponse
{
public Description: string;
public Heading: string;
public WasSuccessful: boolean;
public ModelState: Object;
public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}
export enum WebhookSubscriptionEventType
{
MessageReceived = 1,
}
export class TestSubscription extends ApiServiceRequest implements ILogRequest
{
/** @description The event type being subscribed to */
// @ApiMember(Description="The event type being subscribed to", IsRequired=true)
public EventType: WebhookSubscriptionEventType;
public constructor(init?: Partial<TestSubscription>) { super(init); (Object as any).assign(this, init); }
}
TypeScript 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>