Forms Events

Events related to forms

Subscribe

Subscribe to receive webhooks for forms 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 forms 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/forms
Request samples
application/json
{
  • "Headers": [
    ],
  • "EventTypes": [
    ]
}
Response samples
application/json
{}

Unsubscribe

Unsubscribe from receiving webhooks for forms 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 forms 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/forms
Request samples
Response samples
application/problem+json
{
  • "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 forms 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 forms

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)

get/sites/{SiteSlug}/webhooks/features/forms
Request samples
Response samples
application/json
{}

Form User CreatedWebhook

A form user has been created, ready to have forms issued to them

Request
Request Body schema: application/cloudevent+json

Form User Created

object or null (FormUserCreatedEvent)

Details about the user

type
required
string
Value: "Slipstream.Forms.User.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"
}

Form User UpdatedWebhook

A form user has been updated

Request
Request Body schema: application/cloudevent+json

Form User Updated

object or null (FormUserUpdatedEvent)

Details about the user

type
required
string
Value: "Slipstream.Forms.User.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"
}

Form User DeletedWebhook

A form user has been deleted

Request
Request Body schema: application/cloudevent+json

Form User Deleted

object or null

Details about the user

type
required
string
Value: "Slipstream.Forms.User.Deleted"
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"
}

Form Group CreatedWebhook

A form group has been created, ready to have forms issued to them

Request
Request Body schema: application/cloudevent+json

Form Group Created

object or null (FormGroupCreatedEvent)

Details about the form group

type
required
string
Value: "Slipstream.Forms.Group.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"
}

Form Group UpdatedWebhook

A form group has been updated

Request
Request Body schema: application/cloudevent+json

Form Group Updated

object or null (FormGroupUpdatedEvent)

Details about the form group

type
required
string
Value: "Slipstream.Forms.Group.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"
}

Form Group DeletedWebhook

A form group has been deleted

Request
Request Body schema: application/cloudevent+json

Form Group Deleted

object or null

Details about the form group

type
required
string
Value: "Slipstream.Forms.Group.Deleted"
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"
}

Form Group ExpiredWebhook

A form group has expired

Request
Request Body schema: application/cloudevent+json

Form Group Expired

object or null (FormGroupExpiredEvent)

Details about the form group

type
required
string
Value: "Slipstream.Forms.Group.Expired"
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"
}

Form Group CompletedWebhook

A form group has been completed, ready to have forms issued to it

Request
Request Body schema: application/cloudevent+json

Form Group Completed

object or null (FormGroupCompletedEvent)

Details about the form group

type
required
string
Value: "Slipstream.Forms.Group.Completed"
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"
}

Form CreatedWebhook

A form has been created for a user to fill out

Request
Request Body schema: application/cloudevent+json

Form Created

object or null (FormCreatedEvent)

Details about the form

type
required
string
Value: "Slipstream.Forms.Form.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"
}

Form UpdatedWebhook

A form has been updated

Request
Request Body schema: application/cloudevent+json

Form Updated

object or null (FormUpdatedEvent)

Details about the form

type
required
string
Value: "Slipstream.Forms.Form.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"
}

Form DeletedWebhook

A form has been deleted

Request
Request Body schema: application/cloudevent+json

Form Deleted

object or null

Details about the form

type
required
string
Value: "Slipstream.Forms.Form.Deleted"
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"
}

Form SubmittedWebhook

A form has been submitted by a user

Request
Request Body schema: application/cloudevent+json

Form Submitted

object or null (FormSubmittedEvent)

Details about the form

type
required
string
Value: "Slipstream.Forms.Form.Submitted"
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"
}