SimplyQ API References
API docs by Redocly

SimplyQ API (1.0)

SimplyQ Team: support@simplyq.io URL: https://www.simplyq.io/contact

Application

Applications represent your logical aggregates such as Accounts, Users, etc.

List Applications

List all of the environment's application resources.

Authorizations:
HTTPBearer
query Parameters
limit
integer [ 1 .. 150 ]
Default: 50

The number of results returned

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with resource_obj_0, your subsequent call can include ending_before=resource_obj_0 in order to fetch the previous page of the list.

starting_after
string

A cursor for use in pagination. starting_after is a resource ID that defines your place in the list. For instance, if you make a list request and receive 100 resource objects, ending with resource_obj_n, your subsequent call can include starting_after=resource_obj_n in order to fetch the next page of the list.

before
string <date-time>

Results to return that occurred UP TO the timestamp provided.

after
string <date-time>

Results to return that occurred AFTER the timestamp provided.

Responses

Request samples 

applications = client.applications.list

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "done": true
}

Create Application

Create a new application.

Authorizations:
HTTPBearer
Request Body schema: application/json
uid
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
name
required
string
rate_limit
integer
object (RetryStrategy)
type
string
Enum: "base_exponential_backoff_with_deadline" "exponential_backoff" "exponential_backoff_with_deadline" "fixed_wait" "fixed_wait_with_deadline"

The retry strategy type identifies what algorithm will be used:

Enum Description
base_exponential_backoff_with_deadline Default retry algorithm with up to 6 retries over 8 hours
exponential_backoff Exponential square backoff algo with capped backoff min(2^retryCount, maxBackoff)
exponential_backoff_with_deadline Exponential square backoff algo with capped backoff, which respects the max_retries and deadline, whichever comes first
fixed_wait Retries at fixed interval respecting the max_retries
fixed_wait_with_deadline Retries at fixed interval respecting the max_retries and deadline, whichever comes first

NOTE: Based on the selected algorithm certain fields will be ignored.

max_retries
integer
retry_delay
integer
deadline
integer

Responses

Request samples

Content type
application/json
{
  • "uid": "the-pizza-club",
  • "name": "The Pizza Club",
  • "rate_limit": 1000
}

Response samples

Content type
application/json
{
  • "uid": "the-pizza-club",
  • "name": "The Pizza Club",
  • "rateLimit": 1000,
  • "id": "app_xxx",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieve Application

Get an application resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

Responses

Request samples 

application = client.applications.retrieve("app-uid-1")

Response samples

Content type
application/json
{
  • "uid": "the-pizza-club",
  • "name": "The Pizza Club",
  • "rateLimit": 1000,
  • "id": "app_xxx",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update Application

Update an application resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

Request Body schema: application/json
uid
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
name
required
string
rate_limit
integer
object (RetryStrategy)
type
string
Enum: "base_exponential_backoff_with_deadline" "exponential_backoff" "exponential_backoff_with_deadline" "fixed_wait" "fixed_wait_with_deadline"

The retry strategy type identifies what algorithm will be used:

Enum Description
base_exponential_backoff_with_deadline Default retry algorithm with up to 6 retries over 8 hours
exponential_backoff Exponential square backoff algo with capped backoff min(2^retryCount, maxBackoff)
exponential_backoff_with_deadline Exponential square backoff algo with capped backoff, which respects the max_retries and deadline, whichever comes first
fixed_wait Retries at fixed interval respecting the max_retries
fixed_wait_with_deadline Retries at fixed interval respecting the max_retries and deadline, whichever comes first

NOTE: Based on the selected algorithm certain fields will be ignored.

max_retries
integer
retry_delay
integer
deadline
integer

Responses

Request samples

Content type
application/json
{
  • "uid": "the-pizza-club",
  • "name": "The Pizza Club",
  • "rate_limit": 1000
}

Response samples

Content type
application/json
{
  • "uid": "string",
  • "name": "string",
  • "rate_limit": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "retry_strategy": {
    }
}

Delete Application

Delete an application resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

Responses

Request samples 

boolean_response = client.applications.delete("app-uid-1")

Response samples

Content type
application/json
{
  • "code": "string",
  • "error": "string"
}

Endpoint

Endpoints are associated with an Application and hold the routing rules. Each application can have multiple endpoints and every message sent to the application will be routed to all endpoints - depending on the routing rules at each endpoint the message may not be attempted for a particular endpoint.

List Endpoints

List all of the application's endpoint resources.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

query Parameters
limit
integer [ 1 .. 150 ]
Default: 50

The number of results returned

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with resource_obj_0, your subsequent call can include ending_before=resource_obj_0 in order to fetch the previous page of the list.

starting_after
string

A cursor for use in pagination. starting_after is a resource ID that defines your place in the list. For instance, if you make a list request and receive 100 resource objects, ending with resource_obj_n, your subsequent call can include starting_after=resource_obj_n in order to fetch the next page of the list.

before
string <date-time>

Results to return that occurred UP TO the timestamp provided.

after
string <date-time>

Results to return that occurred AFTER the timestamp provided.

Responses

Request samples 

app_uid = 'app-uid-1'
endpoints = client.endpoints.list(app_uid)

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Endpoint

Create a new endpoint resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

Request Body schema: application/json
uid
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
url
required
string <uri> [ 1 .. 2048 ] characters
version
string^[a-zA-Z0-9\-_.]+$
description
string
filter_types
Array of strings
topics
Array of strings unique
rate_limit
integer >= 1
object (Headers)
headers
object [ 1 .. 10 ] properties
sensitive
object [ 1 .. 10 ] properties
secret
string^whsec_[a-zA-Z0-9]{64}$
active
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "uid": "ep_xxxxx",
  • "url": "https://example.com/webhook/",
  • "version": "v1",
  • "description": "An example endpoint name",
  • "filter_types": [
    ],
  • "topics": [
    ],
  • "rate_limit": 1000,
  • "secret": "whsec_vepZNLxI3tJ2tWEIDAU5BWPJq3yYxm4mV4R65pNLpFk6dTvApVfz7yfTc2grpDC2",
  • "active": true
}

Response samples

Content type
application/json
{
  • "uid": "the-pizza-club-core",
  • "url": "https://example.com/webhook/",
  • "version": "v1",
  • "description": "Example description of the endpoint",
  • "filterTypes": [
    ],
  • "topics": [
    ],
  • "disabled": false,
  • "rateLimit": 1000,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieve Endpoint

Get an endpoint resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

endpoint_id
required
string
Example: ep_xxxxx

The endpoint's UID

Responses

Request samples 

app_uid = 'app-uid-1'
endpoint_uid = 'endpoint-1'
endpoint = client.endpoints.retrieve(app_uid, endpoint_uid)

Response samples

Content type
application/json
{
  • "uid": "the-pizza-club-core",
  • "url": "https://example.com/webhook/",
  • "version": "v1",
  • "description": "Example description of the endpoint",
  • "filterTypes": [
    ],
  • "topics": [
    ],
  • "disabled": false,
  • "rateLimit": 1000,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update Endpoint

Update an endpoint resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

endpoint_id
required
string
Example: ep_xxxxx

The endpoint's UID

Request Body schema: application/json
uid
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
url
required
string <uri> [ 1 .. 2048 ] characters
version
string^[a-zA-Z0-9\-_.]+$
description
string
filter_types
Array of strings
topics
Array of strings unique
rate_limit
integer >= 1
object (Headers)
headers
object [ 1 .. 10 ] properties
sensitive
object [ 1 .. 10 ] properties
secret
string^whsec_[a-zA-Z0-9]{64}$
active
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "uid": "ep_xxxxx",
  • "url": "https://example.com/webhook/",
  • "version": "v1",
  • "description": "An example endpoint name",
  • "filter_types": [
    ],
  • "topics": [
    ],
  • "rate_limit": 1000,
  • "secret": "whsec_vepZNLxI3tJ2tWEIDAU5BWPJq3yYxm4mV4R65pNLpFk6dTvApVfz7yfTc2grpDC2",
  • "active": true
}

Response samples

Content type
application/json
{
  • "uid": "the-pizza-club-core",
  • "url": "https://example.com/webhook/",
  • "version": "v1",
  • "description": "Example description of the endpoint",
  • "filter_types": [
    ],
  • "topics": [
    ],
  • "active": true,
  • "rate_limit": 1000,
  • "headers": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Endpoint

Delete an endpoint resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

endpoint_id
required
string
Example: ep_xxxxx

The endpoint's UID

Responses

Request samples 

app_uid = 'app-uid-1'
endpoint_uid = 'endpoint-1'
endpoint = client.endpoints.delete(app_uid, endpoint_uid)

Response samples

Content type
application/json
{
  • "code": "string",
  • "error": "string"
}

Recover Endpoint

Send faild events to the endpoint.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

endpoint_id
required
string
Example: ep_xxxxx

The endpoint's UID

Request Body schema: application/json
since
string <date-time>

RFC3339 timestamp

Responses

Request samples

Content type
application/json
{
  • "since": "2019-08-24T14:15:22Z"
}

Rotate Endpoint Secret

Rotate the endpoint secret

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

endpoint_id
required
string
Example: ep_xxxxx

The endpoint's UID

Request Body schema: application/json
key
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Retrieve Endpoint Secret

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

endpoint_id
required
string
Example: ep_xxxxx

The endpoint's UID

Responses

Request samples 

app_uid = 'app-uid-1'
endpoint_uid = 'endpoint-1'
secret = client.endpoints.retrieve_secret(app_uid, endpoint_uid)

Response samples

Content type
application/json
{
  • "key": "string"
}

List Endpoint for an Event

List endpoints to which a given Event is delivered to.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

event_id
required
string

The event's ID

query Parameters
limit
integer [ 1 .. 150 ]
Default: 50

The number of results returned

starting_after
string

A cursor for use in pagination. starting_after is a resource ID that defines your place in the list. For instance, if you make a list request and receive 100 resource objects, ending with resource_obj_n, your subsequent call can include starting_after=resource_obj_n in order to fetch the next page of the list.

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with resource_obj_0, your subsequent call can include ending_before=resource_obj_0 in order to fetch the previous page of the list.

Responses

Request samples 

app_uid = 'app-uid-1'
event_uid = 'event-uid-1'
endpoints = client.events.retrieve_endpoints(app_uid, event_uid)

Response samples

Content type
application/json
{
  • "eventType": "account.created",
  • "uid": "8537f7d761-c4356b38a2f20-3184a4490c",
  • "topics": [
    ],
  • "payload": {
    },
  • "retentionPeriod": 15,
  • "created_at": "2019-08-24T14:15:22Z"
}

Event

An event is an envelope that contains metadata and the event data - payload - you wish to send to endpoint(s).

List Events

List all of the application's event resources.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

query Parameters
limit
integer [ 1 .. 150 ]
Default: 50

The number of results returned

event_types
Array of strings unique
Example: event_types=account.created
topics
Array of strings unique
Example: topics=a_b_test_carrot_toppping

Filter by event topics

before
string <date-time>

Results to return that occurred UP TO the timestamp provided.

after
string <date-time>

Results to return that occurred AFTER the timestamp provided.

Responses

Request samples 

app_uid = 'app-uid-1'
events = client.events.list(app_uid)

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create Event

Create a new event resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

Request Body schema: application/json
event_type
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
uid
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
topics
Array of strings unique [ items [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$ ]
payload
object
retention_period
integer

Responses

Request samples

Content type
application/json
{
  • "event_type": "account.created",
  • "uid": "8537f7d761c-4356b38a2f20-3184a4490c",
  • "topics": [
    ],
  • "payload": {
    },
  • "retention_period": 0
}

Response samples

Content type
application/json
{
  • "eventType": "account.created",
  • "uid": "8537f7d761-c4356b38a2f20-3184a4490c",
  • "topics": [
    ],
  • "payload": {
    },
  • "retentionPeriod": 15,
  • "created_at": "2019-08-24T14:15:22Z"
}

Retrieve Event

Get an event resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

event_id
required
string

The event's ID

Responses

Request samples 

app_uid = 'app-uid-1'
event_uid = 'event-uid-1'
event = client.events.retrieve(app_uid, event_uid)

Response samples

Content type
application/json
{
  • "eventType": "account.created",
  • "uid": "8537f7d761-c4356b38a2f20-3184a4490c",
  • "topics": [
    ],
  • "payload": {
    },
  • "retentionPeriod": 15,
  • "created_at": "2019-08-24T14:15:22Z"
}

List Attempted Events for Endpoint

List events for a given Endpoint resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

endpoint_id
required
string
Example: ep_xxxxx

The endpoint's UID

query Parameters
limit
integer [ 1 .. 150 ]
Default: 50

The number of results returned

status
integer
Enum: 0 1 2 3

The delivery status of an Event

event_types
Array of strings unique
Example: event_types=account.created
topics
Array of strings unique
Example: topics=a_b_test_carrot_toppping

Filter by event topics

before
string <date-time>

Results to return that occurred UP TO the timestamp provided.

after
string <date-time>

Results to return that occurred AFTER the timestamp provided.

starting_after
string

A cursor for use in pagination. starting_after is a resource ID that defines your place in the list. For instance, if you make a list request and receive 100 resource objects, ending with resource_obj_n, your subsequent call can include starting_after=resource_obj_n in order to fetch the next page of the list.

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with resource_obj_0, your subsequent call can include ending_before=resource_obj_0 in order to fetch the previous page of the list.

Responses

Request samples 

app_uid = 'app-uid-1'
endpoint_uid = 'endpoint-1'
events = client.endpoint.retrieve_attempted_events(app_uid, endpoint_uid)

Response samples

Content type
application/json
{
  • "eventType": "account.created",
  • "uid": "8537f7d761-c4356b38a2f20-3184a4490c",
  • "topics": [
    ],
  • "payload": {
    },
  • "retentionPeriod": 15,
  • "created_at": "2019-08-24T14:15:22Z"
}

Retry Event

Enqueue event for delivery to the specified Endpoint regardless of its current delivery status.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

event_id
required
string

The event's ID

endpoint_id
required
string
Example: ep_xxxxx

The endpoint's UID

Responses

Request samples 

app_uid = 'app-uid-1'
endpoint_uid = 'endpoint-1'
event_uid = 'event-uid-1'
boolean_response = client.events.retry(app_uid, endpoint_uid, event_uid)

Response samples

Content type
application/json
{
  • "code": "string",
  • "error": "string"
}

DeliveryAttempt

Delivery attempts are logs of our system attempting to deliver an Event to an Endpoint.

List Delivery Attempts for Endpoint

List delivery attempts for a given Endpoint resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

endpoint_id
required
string
query Parameters
limit
integer [ 1 .. 150 ]
Default: 50

The number of results returned

status
integer
Enum: 0 1 2 3

The delivery status of an Event

event_types
Array of strings unique
Example: event_types=account.created
topics
Array of strings unique
Example: topics=a_b_test_carrot_toppping

Filter by event topics

response_status_code
integer
Enum: 0 200 300 400 500

Filter by the delivery attempts response HTTP status code

before
string <date-time>

Results to return that occurred UP TO the timestamp provided.

after
string <date-time>

Results to return that occurred AFTER the timestamp provided.

starting_after
string

A cursor for use in pagination. starting_after is a resource ID that defines your place in the list. For instance, if you make a list request and receive 100 resource objects, ending with resource_obj_n, your subsequent call can include starting_after=resource_obj_n in order to fetch the next page of the list.

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with resource_obj_0, your subsequent call can include ending_before=resource_obj_0 in order to fetch the previous page of the list.

Responses

Request samples 

app_uid = 'app-uid-1'
endpoint_uid = 'endpoint-1'
delivery_attempts = client.endpoints.retrieve_delivery_attempts(app_uid, endpoint_uid)

Response samples

Content type
application/json
{
  • "eventType": "account.created",
  • "uid": "8537f7d761-c4356b38a2f20-3184a4490c",
  • "topics": [
    ],
  • "payload": {
    },
  • "retentionPeriod": 15,
  • "created_at": "2019-08-24T14:15:22Z"
}

List Delivery Attempts for Event

List delivery attempts for a given Endpoint resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

event_id
required
string
query Parameters
limit
integer [ 1 .. 150 ]
Default: 50

The number of results returned

status
integer
Enum: 0 1 2 3

The delivery status of an Event

response_status_code
integer
Enum: 0 200 300 400 500

Filter by the delivery attempts response HTTP status code

before
string <date-time>

Results to return that occurred UP TO the timestamp provided.

after
string <date-time>

Results to return that occurred AFTER the timestamp provided.

starting_after
string

A cursor for use in pagination. starting_after is a resource ID that defines your place in the list. For instance, if you make a list request and receive 100 resource objects, ending with resource_obj_n, your subsequent call can include starting_after=resource_obj_n in order to fetch the next page of the list.

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with resource_obj_0, your subsequent call can include ending_before=resource_obj_0 in order to fetch the previous page of the list.

Responses

Request samples 

app_uid = 'app-uid-1'
event_uid = 'event-uid-1'
delivery_attempts = client.events.retrieve_delivery_attempts(app_uid, event_uid)

Response samples

Content type
application/json
{
  • "eventType": "account.created",
  • "uid": "8537f7d761-c4356b38a2f20-3184a4490c",
  • "topics": [
    ],
  • "payload": {
    },
  • "retentionPeriod": 15,
  • "created_at": "2019-08-24T14:15:22Z"
}

Retrieve Delivery Attempt

List delivery attempts for a given Endpoint resource.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

event_id
required
string

The event's ID

delivery_attempt_id
required
string

Responses

Request samples 

app_uid = 'app-uid-1'
event_uid = 'event-uid-1'
delivery_attempt_id = 'djSDIHVubd42dSAD'
delivery_attempt = client.events.retrieve_delivery_attempt(app_uid, event_uid, delivery_attempt_id)

Response samples

Content type
application/json
{
  • "eventType": "account.created",
  • "uid": "8537f7d761-c4356b38a2f20-3184a4490c",
  • "topics": [
    ],
  • "payload": {
    },
  • "retentionPeriod": 15,
  • "created_at": "2019-08-24T14:15:22Z"
}

List Endpoint for an Event

List endpoints to which a given Event is delivered to.

Authorizations:
HTTPBearer
path Parameters
app_id
required
string [ 1 .. 255 ] characters ^[a-zA-Z0-9\-_.]+$
Example: app_xxx

The application's UID

event_id
required
string

The event's ID

query Parameters
limit
integer [ 1 .. 150 ]
Default: 50

The number of results returned

starting_after
string

A cursor for use in pagination. starting_after is a resource ID that defines your place in the list. For instance, if you make a list request and receive 100 resource objects, ending with resource_obj_n, your subsequent call can include starting_after=resource_obj_n in order to fetch the next page of the list.

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with resource_obj_0, your subsequent call can include ending_before=resource_obj_0 in order to fetch the previous page of the list.

Responses

Request samples 

app_uid = 'app-uid-1'
event_uid = 'event-uid-1'
endpoints = client.events.retrieve_endpoints(app_uid, event_uid)

Response samples

Content type
application/json
{
  • "eventType": "account.created",
  • "uid": "8537f7d761-c4356b38a2f20-3184a4490c",
  • "topics": [
    ],
  • "payload": {
    },
  • "retentionPeriod": 15,
  • "created_at": "2019-08-24T14:15:22Z"
}