Back to AppPricingContact
API Endpoints

Create Endpoint

post
https://api.sinay.ai/webhook/api/v1/endpoint

Create a new endpoint for the application.
Specify the url you wish to receive webhooks and the events you wish to track.
When secret is null the secret is automatically generated (recommended)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
❗️

Endpoint limits

You can have a maximum of 50 endpoints.

If you attempt to create more than 50, the API will return an error. To stay within this limit, consider reusing existing endpoints when possible or deleting unused ones using the DELETE /endpoint API endpoint.

Body Params
string

Description of your endpoint

uint16 | null
≥ 1

Rate limit of your endpoint in messages per second. This is an advanced field. Be aware that setting a low rateLimit can lead to a congestion queue and create delay in webhooks.

string | null
^[a-zA-Z0-9\-_.]+$

Optional unique identifier for the endpoint

uri
required

Public url in your services where you plan to receive our messages. If you don't have a public url ready yet, you can use Svix play to test our webhooks https://www.svix.com/play/

boolean
Defaults to false

When disabled is true, no messages will be sent to your endpoint. This can be used to deactivate a development or a testing endpoint when not in use.

filterTypes
array of strings | null
filterTypes
channels
array of strings | null

List of message channels this endpoint listens to (omit for all) This is an advanced field.

channels
string | null
^(whsec_)?[a-zA-Z0-9+/=]{32,100}$

The endpoint's verification secret. If null is passed (recommanded), a secret is automatically generated. Format: base64 encoded random bytes optionally prefixed with whsec_. Recommended size: 24.

metadata
object

Optional additional properties for your endpoint.

Headers
string

The request's idempotency key

Responses

Updated 12 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago

Did this page help you?