Webhooks (1.0)

Download OpenAPI specification:Download

Webhooks

Create a webhook subscription

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.

Request
Security:
Request Body schema: application/json

The content of the request.

event_type
string

The type of event to subscribe to.

url
string

The URL where Solaris should send the webhook notifications.

Responses
201

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

post/v1/webhooks
Request samples
application/json
{}
Response samples
application/json
{}

Index webhooks

Returns an array containing all of your webhook subscriptions.

Request
Security:
query Parameters
page[number]
string

The number of results pages to return.

page[size]
string

The size of each page in the response.

Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/webhooks
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/webhooks?page%5Bnumber%5D=string&page%5Bsize%5D=string'
Response samples
application/json
[]

Retrieve a webhook

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.

Request
Security:
path Parameters
id
required
string
Responses
200

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

get/v1/webhooks/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/webhooks/{id}'
Response samples
application/json
{}

Delete a webhook

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.

Request
Security:
path Parameters
id
required
string
Responses
204

Successful result of the operation

400

Invalid request.

403

You are not authorized to perform this action.

404

The resource could not be found.

500

Internal server error.

default

Unexpected error

delete/v1/webhooks/{id}
Request samples
curl -i -X DELETE \
  'https://api.solaris-sandbox.de/v1/webhooks/{id}'
Response samples
application/json
"string"