SVsvix
Endpoint

Create Endpoint

Changed on

Create a new endpoint for the application.

When secret is null the secret is automatically generated (recommended).

post/api/v1/app/{app_id}/endpoint

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/app/{app_id}/endpoint
  • Auth
    HTTP bearer

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

Headers

idempotency-keystring

The request's idempotency key

Request body

channelsstring[] nullable

List of message channels this endpoint listens to (omit for all).

descriptionstring
disabledboolean
eventTypesstring[] nullable
headersobject nullable
metadataobject
secretstring nullable

The endpoint's verification secret.

Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.

throttleRateinteger nullable

Maximum messages per second to send to this endpoint.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the endpoint.

urlstring uri required

Example request

{
  "channels": [
    "project_123",
    "group_2"
  ],
  "description": "An example endpoint name",
  "eventTypes": [
    "user.signup",
    "user.deleted"
  ],
  "headers": {
    "X-Example": "123",
    "X-Foobar": "Bar"
  },
  "secret": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD",
  "uid": "unique-identifier",
  "url": "https://example.com/webhook/"
}

Response

channelsstring[] nullable

List of message channels this endpoint listens to (omit for all).

createdAtstring date-time required
descriptionstring required
disabledboolean
eventTypesstring[] nullable
expirystring date-time nullable

When the endpoint expires, if ever.

No messages are sent to the endpoint after this time.

idstring required

The Endpoint's ID.

metadataobject required
throttleRateinteger nullable

Maximum messages per second to send to this endpoint.

Outgoing messages will be throttled to this rate.

uidstring nullable

Optional unique identifier for the endpoint.

updatedAtstring date-time required
urlstring uri required

Example response

{
  "channels": [
    "project_123",
    "group_2"
  ],
  "eventTypes": [
    "user.signup",
    "user.deleted"
  ],
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "uid": "unique-identifier",
  "url": "https://example.com/webhook/"
}

Changes

  • 586c5a0f9e7aRevision changes
    • info

      added the optional property to the response with the status

  • cca56e67e5a4Revision changes
    • warning

      the request property's maxLength was set to 4096

    • info

      added the required property to the response with the status