Application

Create a client application

Create your client application. This step is mandatory before creating endpoints and monitoring shipments. The name of your application should be your company name.

post/application

Request

  • Base URL
    https://api.sinay.ai/webhook/api/v1
  • URL
    https://api.sinay.ai/webhook/api/v1/application
  • Auth
    API key in header API_KEY

Request body

namestring required

The application name can be your company name.

rateLimitinteger nullable

Maximum number of requests you wish to allow to your application by second.

uidstring nullable

Optional unique identifier for the application

metadataobject

Example request

{
  "name": "My company name",
  "uid": "unique-app-identifier"
}

Response

namestring required
rateLimitinteger nullable

Rate limit of your application in messages per second.

createdAtstring date-time required

Example response

{
  "name": "My company name",
  "createdAt": "2024-06-03T09:16:22.854105Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.