Skip to content
/Webhook subscription

Webhooks (1.0)

Download OpenAPI description
webhooks.json
webhooks.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks/

Webhook subscription

Operations

Create a webhook subscription

Request

Creates a new webhook subscription for a specific event.
When you create a webhook subscription, Solaris checks the validity of the provided url by sending a single POST notification. The notification contains an empty body and the SOLARIS-WEBHOOK-EVENT-TYPE header with a value of WEBHOOK-SUBSCRIPTION.
The response from this endpoint contains a unique id for the subscription and a secret. Use this secret to verify the authenticity of the notifications.
Webhook URLs cannot be changed after creating a webhook subscription. You must delete the existing webhook and register a new one with the new URL. Note that you will receive a new id and secret.

Bodyapplication/json

The content of the request.

event_typestring

The type of event to subscribe to.

Example: "IDENTIFICATION"
urlstring

The URL where Solaris should send the webhook notifications.

Example: "https://example.com/identification"
application/json
{
  "event_type": "IDENTIFICATION",
  "url": "https://example.com/identification"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the webhook.

Example: "4c6f93d4c8d427927257e2ce734a5a10"
event_typestring

Type of webhook event.

Example: "IDENTIFICATION"
urlstring

The recipient URL of the event notification.

Example: "https://example.com/identification"
secretstring

A key phrase used to verify the authenticity of received webhook messages.

Example: "f82c389fb187274227186b5a58781978"
Response
application/json
{
  "id": "4c6f93d4c8d427927257e2ce734a5a10",
  "event_type": "IDENTIFICATION",
  "url": "https://example.com/identification",
  "secret": "f82c389fb187274227186b5a58781978"
}

Index webhooks

Request

Returns an array containing all of your webhook subscriptions.

Query
page[number]string

The number of results pages to return.

page[size]string

The size of each page in the response.

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

Unique ID of the webhook.

Example: "4c6f93d4c8d427927257e2ce734a5a10"
event_typestring

Type of webhook event.

Example: "IDENTIFICATION"
urlstring

The recipient URL of the event notification.

Example: "https://example.com/identification"
secretstring

A key phrase used to verify the authenticity of received webhook messages.

Example: "f82c389fb187274227186b5a58781978"
]
Response
application/json
[
  {
    "id": "4c6f93d4c8d427927257e2ce734a5a10",
    "event_type": "IDENTIFICATION",
    "url": "https://example.com/identification",
    "secret": "f82c389fb187274227186b5a58781978"
  }
]

Retrieve a webhook

Request

Returns the webhook subscription specified in the request URL. Note that the API only returns secret value when the webhook is created; this endpoint will return null as the value for secret.

Path
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the webhook.

Example: "4c6f93d4c8d427927257e2ce734a5a10"
event_typestring

Type of webhook event.

Example: "IDENTIFICATION"
urlstring

The recipient URL of the event notification.

Example: "https://example.com/identification"
secretstring

A key phrase used to verify the authenticity of received webhook messages.

Example: "f82c389fb187274227186b5a58781978"
Response
application/json
{
  "id": "4c6f93d4c8d427927257e2ce734a5a10",
  "event_type": "IDENTIFICATION",
  "url": "https://example.com/identification",
  "secret": "f82c389fb187274227186b5a58781978"
}

Delete a webhook

Request

Deletes the webhook subscription specified in the request URL. Please ensure that you have a replacement for a webhook before deleting it; all stored and unsent notifications will be lost.

Path
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
string
Response
application/json
"string"

Webhook events

Webhooks