API Reference
/
Connector API
/
Hooks
/
Create WebHook

Connector API

The Synqly Connector APIs provide a unifying interface and data model for all supported service Providers.

See the Synqly Overview for more information.

Download OpenAPI description
connectors.json
connectors.yaml
Languages
Servers
Synqly
https://api.synqly.com/

Assets

Operations

Edr

Operations

Hooks

Operations

Proxy Webhook

Request

Proxy webhook messages from webhook providers to webhook recievers. For exact webhook implementations please refer to providers e.g. Ticketing. This is just an API call used in that context, not a standalone implementation.

Query
tokenstringrequired

Optional: if you can't use the HTTP Authorization Bearer, specify integration access token here.

metaArray of strings or null

Add metadata to the response by invoking meta functions. Documentation for meta functions is available at https://docs.synqly.com/api-reference/meta-functions. Not all meta function are available at every endpoint.

Bodyapplication/jsonrequired
any
curl -i -X POST \
  'https://api.synqly.com/v1/hooks?meta=string&token=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

Responses

Response
No content

Open Proxy Webhook

Request

Proxy webhook messages from webhook providers to webhook recievers. For exact webhook implementations please refer to providers e.g. Ticketing. This is just an API call used in that context, not a standalone implementation.

Path
webHookCursorstringrequired
Query
metaArray of strings or null

Add metadata to the response by invoking meta functions. Documentation for meta functions is available at https://docs.synqly.com/api-reference/meta-functions. Not all meta function are available at every endpoint.

Bodyapplication/jsonrequired
any
curl -i -X POST \
  'https://api.synqly.com/v1/hooks/passthrough/{webHookCursor}?meta=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

Responses

Response
No content

Create WebHook

Request

Creates a WebHook for the token-linked Integration.

Bodyapplication/jsonrequired
projectstringrequired

Project or Table to link the webhook.

curl -i -X POST \
  https://api.synqly.com/v1/hooks/integration \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "project": "string"
  }'

Responses

Bodyapplication/json
resultobject(IntegrationWebHook)required

Integration webhook

result.​idstring(Id)required
result.​creatorstringrequired

The user who created the webHook.

result.​enabledbooleanrequired

Status of the WebHook.

result.​eventsArray of stringsrequired

List of events that trigger the WebHook.

result.​namestringrequired

A name for the WebHook.

result.​valuestringrequired

The content of the webHook, this can be a URL or a specific code, it depends on the provider.

result.​created_atstring(date-time)required

The date the WebHook was created.

result.​updated_atstring or null(date-time)

The date the WebHook was last updated.

result.​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

Response
application/json
{
  "result": {
    "id": "string",
    "creator": "string",
    "enabled": true,
    "events": [ … ],
    "name": "string",
    "value": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "unmapped": {}
  }
}

Delete WebHook

Request

Deletes the WebHook matching the token-linked Integration.

curl -i -X DELETE \
  https://api.synqly.com/v1/hooks/integration \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response
No content

List WebHooks

Request

Lists all WebHooks from the token-linked Integration.

curl -i -X GET \
  https://api.synqly.com/v1/hooks/integration \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultArray of objects(IntegrationWebHook)required
result[].​idstring(Id)required
result[].​creatorstringrequired

The user who created the webHook.

result[].​enabledbooleanrequired

Status of the WebHook.

result[].​eventsArray of stringsrequired

List of events that trigger the WebHook.

result[].​namestringrequired

A name for the WebHook.

result[].​valuestringrequired

The content of the webHook, this can be a URL or a specific code, it depends on the provider.

result[].​created_atstring(date-time)required

The date the WebHook was created.

result[].​updated_atstring or null(date-time)

The date the WebHook was last updated.

result[].​unmappedobject(Object)

The Object type is used to represent an object with arbitrary fields. The keys are strings and the values are any type.

Response
application/json
{
  "result": [
    { … }
  ]
}

Identity

Operations

Notifications

Operations

Operations (In Development)

In Development

This feature is actively being developed. Breaking changes should be expected.

Please contact us before using this feature.

Operations

Siem

Operations

Sink

Operations

Storage

Operations

Ticketing

Operations

Vulnerabilities

Operations