logo
Powered by Redocly

Physical Post Events

Events related to sending physical post

Subscribe

Subscribe to receive webhooks for physical post events

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
Request Body schema: application/json
required
Uri
required
string <uri>

The URI to deliver the events to

Array of objects or null

The headers that should be sent with the POST request to deliver the event

EventTypes
Array of strings or null

The types of events to subscribe to. If omitted, all events will be delivered

Responses
200

The subscription to physical post events has been created successfully

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

422

Unprocessable - Request was well formed but could not be actioned (ProblemDetails)

424

Failed Dependency Request (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

put/sites/{SiteSlug}/webhooks/features/physicalpost
Request samples
application/json
{}
Response samples
application/json
{}

Unsubscribe

Unsubscribe from receiving webhooks for physical post events

Securityapi_key or azure_auth
Request
path Parameters
SiteSlug
required
string <slug> (Slug) ^[osl][a-zA-Z0-9]{3,}$

The Slipstream slug that uniquely identifies a physical practice

Example: s8n6EzC
Responses
204

The subscription to physical post events has been deleted successfully

400

Malformed Request (ProblemDetails)

401

Unauthorized - Provide proof of identity (ProblemDetails)

403

Forbidden - Insufficient permissions (ProblemDetails)

404

Not Found - Could not find a matching entity (ProblemDetails)

422

Unprocessable - Request was well formed but could not be actioned (ProblemDetails)

429

Too many requests - Chill out (ProblemDetails)

4XX

User Error (ProblemDetails)

5XX

Server Error (ProblemDetails)

delete/sites/{SiteSlug}/webhooks/features/physicalpost
Request samples 
Response samples 
application/problem+json
{
  • "type": "https://httpstatuses.io/400",
  • "title": "The Name field is required.",
  • "detail": "The Name field is required.",
  • "status": 400,
  • "traceId": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00"
}
Get subscription information
Gets subscription information for physical post events


Securityapi_key or azure_auth 
Request 
path Parameters
SiteSlug
required
string <slug>  (Slug) ^[osl][a-zA-Z0-9]{3,}$
The Slipstream slug that uniquely identifies a physical practice


 
 Example:  s8n6EzC
Responses 
200
Information of subscription to physical post events


400
Malformed Request (ProblemDetails)


401
Unauthorized - Provide proof of identity (ProblemDetails)


403
Forbidden - Insufficient permissions (ProblemDetails)


404
Not Found - Could not find a matching entity (ProblemDetails)


409
ProblemDetails


412
ProblemDetails


422
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)


429
Too many requests - Chill out (ProblemDetails)


4XX
User Error (ProblemDetails)


5XX
Server Error (ProblemDetails)


get/sites/{SiteSlug}/webhooks/features/physicalpost
Request samples 
Response samples 
application/json
{}
Letter CreatedWebhook 
A letter has been accepted by the last mile mailing provider (but not yet sent)


Request 
Request Body schema: application/cloudevent+json
Letter Created


object or null (LetterCreatedEvent) 
Details about the letter


 
type
required
string
 Value: "communications.letter.created"  
specversion
required
id
required
source
required
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
siteslug
string <slug>  (Slug) ^[osl][a-zA-Z0-9]{3,}$
A URL-safe unique identifier for an entity (See Sqids)


 
expirytime
intendeddeliverytime
string or null <date-time> 
The time the event is intended to be delivered at. Not delivered before this time.


 
traceparent
tracestate
priority
integer or null
Priority of the event for time-sensitive processing.


 Enum Value Description
0
Normal Priority


1
High Priority


2
Realtime Priority


 
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


 Enum Value Description
Unknown
Unknown PMS - not valid


Testing
Used for automated testing, not a real software system


Exact
Exact Dental


Dentally
Dentally Cloud


Ascend
Ascend


 
dataref
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.


 Enum Value Description
0
Internal


1
Public


2
WorkQueue


3
Private


 
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
 
Responses 
429
Try again later


2xx
Yep, got it


4XX
Can't process event - don't re-deliver


5XX
Something went wrong, try again


Request samples 
application/cloudevent+json
{
  • "data": {
    },
  • "type": "Slipstream.UrlShortener.UrlCreated",
  • "specversion": "string",
  • "id": "string",
  • "source": "http://example.com",
  • "subject": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/slipstreamevent+json",
  • "dataschema": "http://example.com",
  • "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"
}
Letter Creation FailedWebhook 
Event raised when a letter send request fails before the letter is printed


Request 
Request Body schema: application/cloudevent+json
Event raised when a letter send request fails.


object or null (LetterCreationFailedEvent) 
Details about the letter


 
type
required
string
 Value: "communications.letter.creation_failed"  
specversion
required
id
required
source
required
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
siteslug
string <slug>  (Slug) ^[osl][a-zA-Z0-9]{3,}$
A URL-safe unique identifier for an entity (See Sqids)


 
expirytime
intendeddeliverytime
string or null <date-time> 
The time the event is intended to be delivered at. Not delivered before this time.


 
traceparent
tracestate
priority
integer or null
Priority of the event for time-sensitive processing.


 Enum Value Description
0
Normal Priority


1
High Priority


2
Realtime Priority


 
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


 Enum Value Description
Unknown
Unknown PMS - not valid


Testing
Used for automated testing, not a real software system


Exact
Exact Dental


Dentally
Dentally Cloud


Ascend
Ascend


 
dataref
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.


 Enum Value Description
0
Internal


1
Public


2
WorkQueue


3
Private


 
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
 
Responses 
429
Try again later


2xx
Yep, got it


4XX
Can't process event - don't re-deliver


5XX
Something went wrong, try again


Request samples 
application/cloudevent+json
{
  • "data": {
    },
  • "type": "Slipstream.UrlShortener.UrlCreated",
  • "specversion": "string",
  • "id": "string",
  • "source": "http://example.com",
  • "subject": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/slipstreamevent+json",
  • "dataschema": "http://example.com",
  • "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"
}
Letter Status UpdatedWebhook 
Event raised when a letter's status is updated by the mail provider


Request 
Request Body schema: application/cloudevent+json
Event raised when a letter's status is updated.


object or null (LetterStatusUpdatedEvent) 
Details about the letter


 
type
required
string
 Value: "communications.letter.status_updated"  
specversion
required
id
required
source
required
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
siteslug
string <slug>  (Slug) ^[osl][a-zA-Z0-9]{3,}$
A URL-safe unique identifier for an entity (See Sqids)


 
expirytime
intendeddeliverytime
string or null <date-time> 
The time the event is intended to be delivered at. Not delivered before this time.


 
traceparent
tracestate
priority
integer or null
Priority of the event for time-sensitive processing.


 Enum Value Description
0
Normal Priority


1
High Priority


2
Realtime Priority


 
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


 Enum Value Description
Unknown
Unknown PMS - not valid


Testing
Used for automated testing, not a real software system


Exact
Exact Dental


Dentally
Dentally Cloud


Ascend
Ascend


 
dataref
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.


 Enum Value Description
0
Internal


1
Public


2
WorkQueue


3
Private


 
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
 
Responses 
429
Try again later


2xx
Yep, got it


4XX
Can't process event - don't re-deliver


5XX
Something went wrong, try again


Request samples 
application/cloudevent+json
{
  • "data": {
    },
  • "type": "Slipstream.UrlShortener.UrlCreated",
  • "specversion": "string",
  • "id": "string",
  • "source": "http://example.com",
  • "subject": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "datacontenttype": "application/slipstreamevent+json",
  • "dataschema": "http://example.com",
  • "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"
}
➔ Next to Payments Events