Subscribe to receive webhooks for physical post events
SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
The subscription to physical post events has been created successfully
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Failed Dependency Request (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
{- "Headers": [
- {
- "Name": "X-API-KEY",
- "Value": "1234567890abcdef1234567890abcdef"
}
], - "EventTypes": [
- "communications.letter.created"
]
}
{- "Headers": [
- {
- "Name": "X-API-KEY",
- "Value": "1234567890abcdef1234567890abcdef"
}
], - "EventTypes": [
- "communications.letter.created"
]
}
Unsubscribe from receiving webhooks for physical post events
SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
The subscription to physical post events has been deleted successfully
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
{- "title": "The Name field is required.",
- "detail": "The Name field is required.",
- "status": 400,
- "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}
Gets subscription information for physical post events
SiteSlug required | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ The Slipstream slug that uniquely identifies a physical practice Example: s8n6EzC |
Information of subscription to physical post events
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
{- "Headers": [
- "x-api-key"
], - "EventTypes": [
- "communications.letter.created"
], - "Labels": [
- "production"
]
}
A letter has been accepted by the last mile mailing provider (but not yet sent)
Letter Created
object or null (LetterCreatedEvent) Details about the letter | |||||||||||||
type required | |||||||||||||
specversion required | |||||||||||||
id required | |||||||||||||
source required | string <uri> | ||||||||||||
subject | |||||||||||||
time | string or null <date-time> | ||||||||||||
datacontenttype | string or null The content type of the data field. Assume application/slipstreamevent+json if missing | ||||||||||||
dataschema | string or null <uri> | ||||||||||||
siteslug | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ A URL-safe unique identifier for an entity (See Sqids) | ||||||||||||
expirytime | string or null <date-time> | ||||||||||||
intendeddeliverytime | string or null <date-time> The time the event is intended to be delivered at. Not delivered before this time. | ||||||||||||
traceparent | string or null | ||||||||||||
tracestate | |||||||||||||
priority | integer or null Priority of the event for time-sensitive processing.
| ||||||||||||
organisationslug | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ A URL-safe unique identifier for an entity (See Sqids) | ||||||||||||
billingorganisationslug | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ A URL-safe unique identifier for an entity (See Sqids) | ||||||||||||
product | string (PracticeManagementSoftware) Software systems
| ||||||||||||
dataref | string or null <uri> | ||||||||||||
visibility | integer or null Default: 0 Controls the scope of an event's visibility. Possible values: - 0: Internal – The event can be subscribed to by other slipstream services, but is not available as a webhook (default when omitted) - 1: Public – The event is published as a webhook and can be subscribed to by authorized external systems - 2: WorkQueue – The event will be published to a work queue for later processing by the publishing service - 3: Private – The event is not published to a broker; it is only visible within the service publishing it and in telemetry For events from external systems, only Internal and Public are valid values.
| ||||||||||||
billingsku | string or null Encodes a billable item and any relevant options into a billing SKU which decides what it should cost. | ||||||||||||
billingpax | integer or null How many of the given SKU this item should be billed for. Assumed to be 1 if omitted. | ||||||||||||
pmsspecificid | string (PmsSpecificPracticeId) The PMS-specific id that uniquely identifies a physical practice | ||||||||||||
property name* additional property | any |
Try again later
Yep, got it
Can't process event - don't re-deliver
Something went wrong, try again
{- "data": {
- "recordId": "064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e",
- "color": false,
- "express": false
}, - "type": "Slipstream.UrlShortener.UrlCreated",
- "specversion": "string",
- "id": "string",
- "subject": "string",
- "time": "2019-08-24T14:15:22Z",
- "datacontenttype": "application/slipstreamevent+json",
- "siteslug": "s8n6EzC",
- "expirytime": "2021-04-24T18:25:43.511Z",
- "intendeddeliverytime": "2021-04-23T20:25:43.511Z",
- "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
- "tracestate": "string",
- "priority": 1,
- "organisationslug": "s8n6EzC",
- "billingorganisationslug": "s8n6EzC",
- "product": "Unknown",
- "dataref": "/some/dataref",
- "visibility": 0,
- "billingsku": "string",
- "billingpax": 1,
- "pmsspecificid": "04d2f2f0-8f1a-11eb-8dcd-0242ac130003"
}
Event raised when a letter send request fails before the letter is printed
Event raised when a letter send request fails.
object or null (LetterCreationFailedEvent) Details about the letter | |||||||||||||
type required | |||||||||||||
specversion required | |||||||||||||
id required | |||||||||||||
source required | string <uri> | ||||||||||||
subject | |||||||||||||
time | string or null <date-time> | ||||||||||||
datacontenttype | string or null The content type of the data field. Assume application/slipstreamevent+json if missing | ||||||||||||
dataschema | string or null <uri> | ||||||||||||
siteslug | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ A URL-safe unique identifier for an entity (See Sqids) | ||||||||||||
expirytime | string or null <date-time> | ||||||||||||
intendeddeliverytime | string or null <date-time> The time the event is intended to be delivered at. Not delivered before this time. | ||||||||||||
traceparent | string or null | ||||||||||||
tracestate | |||||||||||||
priority | integer or null Priority of the event for time-sensitive processing.
| ||||||||||||
organisationslug | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ A URL-safe unique identifier for an entity (See Sqids) | ||||||||||||
billingorganisationslug | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ A URL-safe unique identifier for an entity (See Sqids) | ||||||||||||
product | string (PracticeManagementSoftware) Software systems
| ||||||||||||
dataref | string or null <uri> | ||||||||||||
visibility | integer or null Default: 0 Controls the scope of an event's visibility. Possible values: - 0: Internal – The event can be subscribed to by other slipstream services, but is not available as a webhook (default when omitted) - 1: Public – The event is published as a webhook and can be subscribed to by authorized external systems - 2: WorkQueue – The event will be published to a work queue for later processing by the publishing service - 3: Private – The event is not published to a broker; it is only visible within the service publishing it and in telemetry For events from external systems, only Internal and Public are valid values.
| ||||||||||||
billingsku | string or null Encodes a billable item and any relevant options into a billing SKU which decides what it should cost. | ||||||||||||
billingpax | integer or null How many of the given SKU this item should be billed for. Assumed to be 1 if omitted. | ||||||||||||
pmsspecificid | string (PmsSpecificPracticeId) The PMS-specific id that uniquely identifies a physical practice | ||||||||||||
property name* additional property | any |
Try again later
Yep, got it
Can't process event - don't re-deliver
Something went wrong, try again
{- "data": {
- "recordId": "064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e",
- "color": false,
- "express": false
}, - "type": "Slipstream.UrlShortener.UrlCreated",
- "specversion": "string",
- "id": "string",
- "subject": "string",
- "time": "2019-08-24T14:15:22Z",
- "datacontenttype": "application/slipstreamevent+json",
- "siteslug": "s8n6EzC",
- "expirytime": "2021-04-24T18:25:43.511Z",
- "intendeddeliverytime": "2021-04-23T20:25:43.511Z",
- "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
- "tracestate": "string",
- "priority": 1,
- "organisationslug": "s8n6EzC",
- "billingorganisationslug": "s8n6EzC",
- "product": "Unknown",
- "dataref": "/some/dataref",
- "visibility": 0,
- "billingsku": "string",
- "billingpax": 1,
- "pmsspecificid": "04d2f2f0-8f1a-11eb-8dcd-0242ac130003"
}
Event raised when a letter's status is updated by the mail provider
Event raised when a letter's status is updated.
object or null (LetterStatusUpdatedEvent) Details about the letter | |||||||||||||
type required | |||||||||||||
specversion required | |||||||||||||
id required | |||||||||||||
source required | string <uri> | ||||||||||||
subject | |||||||||||||
time | string or null <date-time> | ||||||||||||
datacontenttype | string or null The content type of the data field. Assume application/slipstreamevent+json if missing | ||||||||||||
dataschema | string or null <uri> | ||||||||||||
siteslug | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ A URL-safe unique identifier for an entity (See Sqids) | ||||||||||||
expirytime | string or null <date-time> | ||||||||||||
intendeddeliverytime | string or null <date-time> The time the event is intended to be delivered at. Not delivered before this time. | ||||||||||||
traceparent | string or null | ||||||||||||
tracestate | |||||||||||||
priority | integer or null Priority of the event for time-sensitive processing.
| ||||||||||||
organisationslug | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ A URL-safe unique identifier for an entity (See Sqids) | ||||||||||||
billingorganisationslug | string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$ A URL-safe unique identifier for an entity (See Sqids) | ||||||||||||
product | string (PracticeManagementSoftware) Software systems
| ||||||||||||
dataref | string or null <uri> | ||||||||||||
visibility | integer or null Default: 0 Controls the scope of an event's visibility. Possible values: - 0: Internal – The event can be subscribed to by other slipstream services, but is not available as a webhook (default when omitted) - 1: Public – The event is published as a webhook and can be subscribed to by authorized external systems - 2: WorkQueue – The event will be published to a work queue for later processing by the publishing service - 3: Private – The event is not published to a broker; it is only visible within the service publishing it and in telemetry For events from external systems, only Internal and Public are valid values.
| ||||||||||||
billingsku | string or null Encodes a billable item and any relevant options into a billing SKU which decides what it should cost. | ||||||||||||
billingpax | integer or null How many of the given SKU this item should be billed for. Assumed to be 1 if omitted. | ||||||||||||
pmsspecificid | string (PmsSpecificPracticeId) The PMS-specific id that uniquely identifies a physical practice | ||||||||||||
property name* additional property | any |
Try again later
Yep, got it
Can't process event - don't re-deliver
Something went wrong, try again
{- "data": {
- "recordId": "064a5f0e-0b0e-4e1e-8e1e-0e0e0e0e0e0e",
- "color": false,
- "express": false
}, - "type": "Slipstream.UrlShortener.UrlCreated",
- "specversion": "string",
- "id": "string",
- "subject": "string",
- "time": "2019-08-24T14:15:22Z",
- "datacontenttype": "application/slipstreamevent+json",
- "siteslug": "s8n6EzC",
- "expirytime": "2021-04-24T18:25:43.511Z",
- "intendeddeliverytime": "2021-04-23T20:25:43.511Z",
- "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
- "tracestate": "string",
- "priority": 1,
- "organisationslug": "s8n6EzC",
- "billingorganisationslug": "s8n6EzC",
- "product": "Unknown",
- "dataref": "/some/dataref",
- "visibility": 0,
- "billingsku": "string",
- "billingpax": 1,
- "pmsspecificid": "04d2f2f0-8f1a-11eb-8dcd-0242ac130003"
}