ECG Webhooks Module API (1.0)

Download OpenAPI specification:Download

Documentation for webhooks module

Authentication

bearer

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Health

Checks health of the server

Responses
200

The Health Check is successful

503

The Health Check is not successful

get/healthcheck
Request samples
curl -i -X GET \
  /healthcheck
Response samples
application/json
{
  • "status": "ok",
  • "info": {
    },
  • "error": { },
  • "details": {
    }
}

WebhookCategories

Adds the Webhook Category.

Request
Security:
bearer
Request Body schema: application/json
name
required
string
code
required
string
description
string
Responses
201
post/api/webhook-categories
Request samples
application/json
{
  • "name": "string",
  • "code": "string",
  • "description": "string | null"
}
Response samples
application/json
{
  • "id": "e7d7d5c7-e8cd-47ed-9d86-29200cbd5010",
  • "name": "string",
  • "description": "string",
  • "code": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Lists all the available Webhook Categories.

Request
Security:
bearer
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
any

Default value : 0

take
any

Default value : 10

Example: take=10
Responses
200
get/api/webhook-categories
Request samples
curl -i -X GET \
  '/api/webhook-categories?order_by=ASC' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Delete the Webhook Category.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
Responses
200
delete/api/webhook-categories/{webhookCategoryId}
Request samples
curl -i -X DELETE \
  '/api/webhook-categories/{webhookCategoryId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Gets the Webhook Category information.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
Responses
200
get/api/webhook-categories/{webhookCategoryId}
Request samples
curl -i -X GET \
  '/api/webhook-categories/{webhookCategoryId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "e7d7d5c7-e8cd-47ed-9d86-29200cbd5010",
  • "name": "string",
  • "description": "string",
  • "code": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Patch the Webhook Category information by updating the items they were provided.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
Request Body schema: application/json
Array
value
required
object
path
required
string
op
required
string
Responses
200
patch/api/webhook-categories/{webhookCategoryId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "e7d7d5c7-e8cd-47ed-9d86-29200cbd5010",
  • "name": "string",
  • "description": "string",
  • "code": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Archives the Webhook Category information.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
Responses
200
post/api/webhook-categories/{webhookCategoryId}/archive
Request samples
curl -i -X POST \
  '/api/webhook-categories/{webhookCategoryId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Webhook Category information.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
Responses
200
post/api/webhook-categories/{webhookCategoryId}/restore
Request samples
curl -i -X POST \
  '/api/webhook-categories/{webhookCategoryId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Activates the Webhook Category information.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
Responses
200
post/api/webhook-categories/{webhookCategoryId}/activate
Request samples
curl -i -X POST \
  '/api/webhook-categories/{webhookCategoryId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivates the Webhook Category information.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
Responses
200
post/api/webhook-categories/{webhookCategoryId}/deactivate
Request samples
curl -i -X POST \
  '/api/webhook-categories/{webhookCategoryId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

SeedData

Lists the available version.

Request
Security:
bearer
Responses
200
get/api/seed-data/versions
Request samples
curl -i -X GET \
  /api/seed-data/versions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
[
  • { }
]

WebhookEvents

Adds the Webhook Event.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
Request Body schema: application/json
name
required
string
code
required
string
description
string
version
required
string
Responses
201
post/api/webhook-categories/{webhookCategoryId}/webhook-events
Request samples
application/json
{
  • "name": "string",
  • "code": "string",
  • "description": "string | null",
  • "version": "string"
}
Response samples
application/json
{
  • "id": "2d283274-5e08-4646-8db9-57f3a05c77c0",
  • "name": "string",
  • "description": "string",
  • "version": "string",
  • "code": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "webhookCategory": {
    }
}

Lists all the available Webhook Events.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
any

Default value : 0

take
any

Default value : 10

Example: take=10
Responses
200
get/api/webhook-categories/{webhookCategoryId}/webhook-events
Request samples
curl -i -X GET \
  '/api/webhook-categories/{webhookCategoryId}/webhook-events?order_by=ASC' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Delete the Webhook Event.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
Responses
200
delete/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}
Request samples
curl -i -X DELETE \
  '/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Gets the Webhook Event information.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
Responses
200
get/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}
Request samples
curl -i -X GET \
  '/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "2d283274-5e08-4646-8db9-57f3a05c77c0",
  • "name": "string",
  • "description": "string",
  • "version": "string",
  • "code": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "webhookCategory": {
    }
}

Patch the Webhook Event information by updating the items they were provided.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
Request Body schema: application/json
Array
value
required
object
path
required
string
op
required
string
Responses
200
patch/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "2d283274-5e08-4646-8db9-57f3a05c77c0",
  • "name": "string",
  • "description": "string",
  • "version": "string",
  • "code": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "webhookCategory": {
    }
}

Archives the Webhook Event information.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
Responses
200
post/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/archive
Request samples
curl -i -X POST \
  '/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Webhook Event information.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
Responses
200
post/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/restore
Request samples
curl -i -X POST \
  '/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Activates the Webhook Event information.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
Responses
200
post/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/activate
Request samples
curl -i -X POST \
  '/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivates the Webhook Event information.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
Responses
200
post/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/deactivate
Request samples
curl -i -X POST \
  '/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists all the available subscription for given event.

Request
Security:
bearer
path Parameters
eventCode
required
string
Responses
200
get/api/webhook-events/{eventCode}/subscriptions
Request samples
curl -i -X GET \
  '/api/webhook-events/{eventCode}/subscriptions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
[
  • {
    }
]

WebhookSubscriptions

Adds the Webhook Subscription for given organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
Request Body schema: application/json
postUri
string
events
Array of strings
version
string
isDevelopment
required
boolean
Responses
201
post/api/organizations/{organizationId}/webhook-subscriptions
Request samples
application/json
{
  • "postUri": "string",
  • "events": [
    ],
  • "version": "string",
  • "isDevelopment": false
}
Response samples
application/json
{
  • "id": "011fe3bd-6513-4da4-a934-48538497a1c9",
  • "organizationId": "7152ff07-72b4-4934-b96c-9283003188a1",
  • "postUri": "string",
  • "version": "string",
  • "secretKey": "string",
  • "events": [
    ],
  • "isDevelopment": false,
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "archiveInfo": {
    }
}

Lists all the available Webhook Subscriptions.

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
version
any
Example: version=v1
eventId
any
Example: eventId=78aa2e1f-3849-431f-b888-40ebedd8e540
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
any

Default value : 0

take
any

Default value : 10

Example: take=10
Responses
200
get/api/organizations/{organizationId}/webhook-subscriptions
Request samples
curl -i -X GET \
  '/api/organizations/{organizationId}/webhook-subscriptions?order_by=ASC' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Deletes the Webhook Subscription for given organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
Responses
200
delete/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}
Request samples
curl -i -X DELETE \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Gets the Webhook Subscription information for given organization.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
Responses
200
get/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}
Request samples
curl -i -X GET \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "011fe3bd-6513-4da4-a934-48538497a1c9",
  • "organizationId": "7152ff07-72b4-4934-b96c-9283003188a1",
  • "postUri": "string",
  • "version": "string",
  • "secretKey": "string",
  • "events": [
    ],
  • "isDevelopment": false,
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "archiveInfo": {
    }
}

Patches the Webhook Subscription information by updating the items they were provided.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
Request Body schema: application/json
Array
value
required
object
path
required
string
op
required
string
Responses
200
patch/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "011fe3bd-6513-4da4-a934-48538497a1c9",
  • "organizationId": "7152ff07-72b4-4934-b96c-9283003188a1",
  • "postUri": "string",
  • "version": "string",
  • "secretKey": "string",
  • "events": [
    ],
  • "isDevelopment": false,
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "archiveInfo": {
    }
}

Activates the Webhook Subscription information.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
Responses
200
post/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activate
Request samples
curl -i -X POST \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivates the Webhook Subscription information.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
Responses
200
post/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/deactivate
Request samples
curl -i -X POST \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Gets the Webhook Subscription Secret Key information.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
query Parameters
createdAt
any
Example: createdAt=2022-08-18T10:03:04.086Z
Responses
200
get/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/secrets
Request samples
curl -i -X GET \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/secrets' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "secretKey": "random-string"
}

Updates the Webhook Subscription Secret Key information.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
Responses
200
put/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/secrets
Request samples
curl -i -X PUT \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/secrets' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Delete the Webhook Event from Webhook Subscription.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
eventId
required
string
Responses
200
delete/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/events/{eventId}
Request samples
curl -i -X DELETE \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/events/{eventId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Lists all the available Webhook Activation history details for Webhook Subscription.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
any

Default value : 0

take
any

Default value : 10

Example: take=10
status
string

Default value : all

Enum: "all" "succeeded" "failed"
Example: status=all
Responses
200
get/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activations
Request samples
curl -i -X GET \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activations?order_by=ASC&status=all' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets the Webhook Activation History information for Webhook Subscription.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
activationId
required
string
Responses
200
get/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activations/{activationId}
Request samples
curl -i -X GET \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activations/{activationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "70f45231-3bda-4866-9ec4-1dceca510c34",
  • "type": 0,
  • "postedAt": "2022-08-18T10:03:03.750Z",
  • "httpStatusCode": 200,
  • "payload": "any",
  • "rawMessage": { },
  • "subscription": {
    },
  • "event": {
    },
  • "retryingFromPostId": "41410db1-2572-49d0-9421-f40c723240c6",
  • "nextRetryAt": "datetime",
  • "rawResponse": "any",
  • "error": "string",
  • "success": true,
  • "auditInfo": {
    }
}

Archives the Webhook Subscription information.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
Responses
200
post/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/archive
Request samples
curl -i -X POST \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Restores the Webhook Subscription information.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
Responses
200
post/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/restore
Request samples
curl -i -X POST \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

SampleWebhookPayloads

Adds sample webhook payload for given event.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
Request Body schema: application/json
payload
required
object
version
string
Responses
201
post/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/sample-payloads
Request samples
application/json
{
  • "payload": {
    },
  • "version": "v1"
}
Response samples
application/json
{
  • "id": "048a7091-e29d-450c-8472-c8ca226d55bb",
  • "event": {
    },
  • "payload": "{}",
  • "version": "string",
  • "auditInfo": {
    }
}

Gets the sample webhook payload for given event.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
query Parameters
version
required
string
Responses
200
get/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/sample-payloads
Request samples
curl -i -X GET \
  '/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/sample-payloads?version=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "e7d7d5c7-e8cd-47ed-9d86-29200cbd5010",
  • "name": "string",
  • "description": "string",
  • "code": "string",
  • "archiveInfo": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Delete the sample webhook payload for given event.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
query Parameters
version
required
string
Responses
200
delete/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/sample-payloads
Request samples
curl -i -X DELETE \
  '/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/sample-payloads?version=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Patches the webhook payload information by updating the items they were provided.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
query Parameters
version
required
string
Request Body schema: application/json
Array
value
required
object
path
required
string
op
required
string
Responses
200
patch/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/sample-payloads
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "048a7091-e29d-450c-8472-c8ca226d55bb",
  • "event": {
    },
  • "payload": "{}",
  • "version": "string",
  • "auditInfo": {
    }
}

Gets the sample webhook payload examples for given event.

Request
Security:
bearer
path Parameters
webhookCategoryId
required
string
webhookEventId
required
string
query Parameters
type
required
string
Default: "ack"
Enum: "ack" "nack" "phone-log" "vitals-observation"
Responses
200
get/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/sample-payloads-examples
Request samples
curl -i -X GET \
  '/api/webhook-categories/{webhookCategoryId}/webhook-events/{webhookEventId}/sample-payloads-examples?type=ack' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

WebhookActivities

Add webhook post activity for given subscription.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
Request Body schema: application/json
type
required
number
payload
required
object
rawMessage
required
object
eventId
required
string
retryingFromPostId
string
postedAt
string <date-time>
Responses
201
post/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activity
Request samples
application/json
{
  • "type": 1,
  • "payload": { },
  • "rawMessage": { },
  • "eventId": "7b05a9be-1c08-415e-b9ef-2f41bc38b115",
  • "retryingFromPostId": "d115cfd9-c99d-4d7a-abca-94ae149f564d",
  • "postedAt": ""
}
Response samples
application/json
{
  • "id": "70f45231-3bda-4866-9ec4-1dceca510c34",
  • "type": 0,
  • "postedAt": "2022-08-18T10:03:03.750Z",
  • "httpStatusCode": 200,
  • "payload": "any",
  • "rawMessage": { },
  • "subscription": {
    },
  • "event": {
    },
  • "retryingFromPostId": "41410db1-2572-49d0-9421-f40c723240c6",
  • "nextRetryAt": "datetime",
  • "rawResponse": "any",
  • "error": "string",
  • "success": true,
  • "auditInfo": {
    }
}

Lists webhook post activity for given subscription.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
query Parameters
include
Array of strings
Items Enum: "subscription" "event"
status
string

Default value : all

Enum: "all" "succeeded" "failed"
Example: status=all
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
any

Default value : 0

take
any

Default value : 10

Example: take=10
eventId
any

Default value:null

Example: eventId=6d0a26b7-ab86-4b44-8253-78868da66bc0
Responses
200
get/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activity
Request samples
curl -i -X GET \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activity?include=subscription&status=all&order_by=ASC' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Add webhook post activity for retry call for failed webhook.

Request
Security:
bearer
path Parameters
activityId
required
string
Responses
201
post/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activity/{activityId}/retry
Request samples
curl -i -X POST \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activity/{activityId}/retry' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "70f45231-3bda-4866-9ec4-1dceca510c34",
  • "type": 0,
  • "postedAt": "2022-08-18T10:03:03.750Z",
  • "httpStatusCode": 200,
  • "payload": "any",
  • "rawMessage": { },
  • "subscription": {
    },
  • "event": {
    },
  • "retryingFromPostId": "41410db1-2572-49d0-9421-f40c723240c6",
  • "nextRetryAt": "datetime",
  • "rawResponse": "any",
  • "error": "string",
  • "success": true,
  • "auditInfo": {
    }
}

Save outcome of webhook post activity.

Request
Security:
bearer
path Parameters
activityId
required
string
Request Body schema: application/json
originalActivityId
required
string
success
required
boolean
httpStatusCode
required
number
error
required
string
rawResponse
required
object
Responses
201
post/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activity/{activityId}/outcomes
Request samples
application/json
{
  • "originalActivityId": "1eea45e8-3b23-4a23-9b91-323d095c2dd9",
  • "success": "true",
  • "httpStatusCode": "200",
  • "error": "string",
  • "rawResponse": "{vitals:100}"
}
Response samples
application/json
{
  • "id": "70f45231-3bda-4866-9ec4-1dceca510c34",
  • "type": 0,
  • "postedAt": "2022-08-18T10:03:03.750Z",
  • "httpStatusCode": 200,
  • "payload": "any",
  • "rawMessage": { },
  • "subscription": {
    },
  • "event": {
    },
  • "retryingFromPostId": "41410db1-2572-49d0-9421-f40c723240c6",
  • "nextRetryAt": "datetime",
  • "rawResponse": "any",
  • "error": "string",
  • "success": true,
  • "auditInfo": {
    }
}

Get webhook activity details for given id.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
activityId
required
string
query Parameters
mode
required
string
Enum: "flat" "nested"
Responses
200
get/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activity/{activityId}
Request samples
curl -i -X GET \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/activity/{activityId}?mode=flat' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "bdf47e51-352e-4680-a67a-2d83a3080eb3",
  • "level": 1,
  • "type": 1,
  • "posted_at": "date | null",
  • "payload": "any",
  • "subscription": {
    },
  • "event": {
    },
  • "retryingFromPostId": "9189522e-872f-4478-ac92-f7ce854d344e",
  • "nextRetryAt": "2022-08-18T10:03:03.754Z",
  • "rawResponse": "any",
  • "error": "string",
  • "success": false,
  • "childPostHistory": [ ]
}

WebhookProcessors

Test URL for webhook subscription with success response.

Request
Security:
bearer
Responses
200
post/api/webhook-processors/success-response
Request samples
curl -i -X POST \
  /api/webhook-processors/success-response \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Test URL for webhook subscription with failed response.

Request
Security:
bearer
Responses
200
post/api/webhook-processors/failed-response
Request samples
curl -i -X POST \
  /api/webhook-processors/failed-response \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

WebhookPayloadHash

Generates the webhook payload with hash and adds activity for given subscription.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
query Parameters
mode
required
string
originalActivityId
string
Request Body schema: application/json
eventType
required
string
version
required
string
Enum: "v1" "v2"
data
required
object
Responses
201
post/api/organizations/{organizationId}/subscriptions/{subscriptionId}/webhooks-payloads
Request samples
application/json
{
  • "eventType": "vitals.observations.created",
  • "version": "v1",
  • "data": "{vitals:100}"
}

Validate hash for given payload.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
Request Body schema: application/json
payload
required
object
hash
required
string
createdAt
required
number
Responses
200
post/api/organizations/{organizationId}/subscriptions/{subscriptionId}/validate-hash
Request samples
application/json
{
  • "payload": "{vitals:100}",
  • "hash": "35c47c04434c647c7d05d0e79dcdf220415edaf4d3e9dc73bbe790b2edcf22c5",
  • "createdAt": 12345
}

Gets hash for given payload.

Request
Security:
bearer
path Parameters
activityId
required
string
organizationId
required
string
subscriptionId
required
string
Responses
200
get/api/organizations/{organizationId}/subscriptions/{subscriptionId}/activity/{activityId}/get-hash
Request samples
curl -i -X GET \
  '/api/organizations/{organizationId}/subscriptions/{subscriptionId}/activity/{activityId}/get-hash' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

WebhookSecretHistories

Lists all the available Webhook Secret history.

Request
Security:
bearer
path Parameters
organizationId
required
string
subscriptionId
required
string
query Parameters
order_by
string
Enum: "ASC" "DESC"
Example: order_by=ASC
skip
any

Default value : 0

take
any

Default value : 10

Example: take=10
include
string

For query include=subscription, it returns subscription with webhook-secret-history.

Value: "subscription"
Responses
200
get/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/webhook-secret-histories
Request samples
curl -i -X GET \
  '/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/webhook-secret-histories?order_by=ASC&include=subscription' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Updates secret key for given subscription and adds in secret history.

Request
Security:
bearer
path Parameters
subscriptionId
required
string
organizationId
required
string
Request Body schema: application/json
secretKey
required
string
Responses
201
post/api/organizations/{organizationId}/webhook-subscriptions/{subscriptionId}/webhook-secret-histories
Request samples
application/json
{
  • "secretKey": "ecg-secret-key"
}

WebhookDeliveries

Gets random payload to deliver for webhook.

Request
Security:
bearer
Responses
200
get/api/webhook-deliveries/payload
Request samples
curl -i -X GET \
  /api/webhook-deliveries/payload \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'