| POST | /subscription/{EventType} | Subscribe to an event with a url we should post to | |
|---|---|---|---|
| POST | /subscription | Subscribe to an event with a url we should post to |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey):
# @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
api_key: Optional[str] = None
"""
The API Key required for authentication
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
description: Optional[str] = None
heading: Optional[str] = None
was_successful: bool = False
model_state: Optional[Object] = None
class WebhookSubscriptionEventType(IntEnum):
MESSAGE_RECEIVED = 1
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddSubscription(ApiServiceRequest, ILogRequest):
# @ApiMember(Description="The event type being subscribed to", IsRequired=true)
event_type: Optional[WebhookSubscriptionEventType] = None
"""
The event type being subscribed to
"""
# @ApiMember(Description="The URL we should post the event data to", IsRequired=true)
subscription_url: Optional[str] = None
"""
The URL we should post the event data to
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /subscription/{EventType} HTTP/1.1
Host: galaxymobile.api.client.prod.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
EventType: 1,
SubscriptionUrl: String,
ApiKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Description: String,
Heading: String,
WasSuccessful: False,
ModelState: {}
}