Skip to content
Askara API/
/
Create a webhook.

Askara API (1.0.0)

Askara.ai open API

Languages
Servers
Production
https://api.askara.ai/

Audio

Resource 'Audio' operations.

Operations

Contact

Resource 'Contact' operations.

Operations

Document

Resource 'Document' operations.

Operations

Organization

Resource 'Organization' operations.

Operations

Patient

Resource 'Patient' operations.

Operations

User

Resource 'User' operations.

Operations

Webhook

Resource 'Webhook' operations.

Operations

Retrieve collection of webhooks.

Request

Use this endpoint to retrieve the collection of webhook information.

Query
pageinteger

The collection page number

Default 1
itemsPerPageinteger[ 0 .. 100 ]

The number of items per page

Default 20
order[uuid]string
Enum"asc""desc"
order[organization]string
Enum"asc""desc"
order[user]string
Enum"asc""desc"
order[url]string
Enum"asc""desc"
order[secret]string
Enum"asc""desc"
order[certificateVerificationDisabled]string
Enum"asc""desc"
order[enabled]string
Enum"asc""desc"
order[subscriptions]string
Enum"asc""desc"
order[createdAt]string
Enum"asc""desc"
order[updatedAt]string
Enum"asc""desc"
searchstring

Global case-insensitive text search.

uuidstring
uuid[]Array of strings
organizationstring
organization[]Array of strings
user.emailstring
user.email[]Array of strings
urlstring
url[]Array of strings
subscriptionsstring
subscriptions[]Array of strings
user.uuidstring
user.uuid[]Array of strings
certificateVerificationDisabledboolean
enabledboolean
createdAt[between]string
createdAt[gt]string
createdAt[gte]string
createdAt[lt]string
createdAt[lte]string
updatedAt[between]string
updatedAt[gt]string
updatedAt[gte]string
updatedAt[lt]string
updatedAt[lte]string
curl -i -X GET \
  'https://api.askara.ai/webhooks?page=1&itemsPerPage=20&order%5Buuid%5D=asc&order%5Borganization%5D=asc&order%5Buser%5D=asc&order%5Burl%5D=asc&order%5Bsecret%5D=asc&order%5BcertificateVerificationDisabled%5D=asc&order%5Benabled%5D=asc&order%5Bsubscriptions%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&search=string&uuid=string&uuid%5B%5D=string&organization=string&organization%5B%5D=string&user.email=string&user.email%5B%5D=string&url=string&url%5B%5D=string&subscriptions=string&subscriptions%5B%5D=string&user.uuid=string&user.uuid%5B%5D=string&certificateVerificationDisabled=true&enabled=true&createdAt%5Bbetween%5D=string&createdAt%5Bgt%5D=string&createdAt%5Bgte%5D=string&createdAt%5Blt%5D=string&createdAt%5Blte%5D=string&updatedAt%5Bbetween%5D=string&updatedAt%5Bgt%5D=string&updatedAt%5Bgte%5D=string&updatedAt%5Blt%5D=string&updatedAt%5Blte%5D=string'

Responses

Webhook collection

Body
Array [
uuidstring or null(uuid)

Webhook unique identifier.

organizationstring or null(uuid)
Example: "123e4567-e89b-12d3-a456-426614174000"
userstring or null(uuid)
Example: "123e4567-e89b-12d3-a456-426614174000"
enabledboolean
Default true
createdAtstring(date-time)

Webhook creation date.

updatedAtstring(date-time)

Webhook update date.

]
Response
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "enabled": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

Create a webhook.

Request

Use this endpoint to create a webhook entity.

Body
required

The new Webhook resource

urlstring or null(uri)required
https://schema.org/url
subscriptionsstring or nullrequired
curl -i -X POST \
  https://api.askara.ai/webhooks \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "http://example.com",
    "subscriptions": "string"
  }'

Responses

Webhook resource created

Body
uuidstring or null(uuid)

Webhook unique identifier.

organizationstring or null(uuid)
Example: "123e4567-e89b-12d3-a456-426614174000"
userstring or null(uuid)
Example: "123e4567-e89b-12d3-a456-426614174000"
urlstring(uri)<= 500 charactersrequired
https://schema.org/url
secretstring or null
certificateVerificationDisabledboolean or null
enabledboolean
Default true
subscriptionsArray of strings

Webhook subscriptions.

Items Enum"new_document""new_patient""new_contact""new_summary"
Example: ["new_document"]
createdAtstring(date-time)

Webhook creation date.

updatedAtstring(date-time)

Webhook update date.

Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "url": "http://example.com",
  "secret": "string",
  "certificateVerificationDisabled": true,
  "enabled": true,
  "subscriptions": [
    "new_document"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieve a webhook.

Request

Use this endpoint to retrieve a webhook information.

Path
uuidstringrequired

Webhook identifier

curl -i -X GET \
  'https://api.askara.ai/webhooks/{uuid}'

Responses

Webhook resource

Body
uuidstring or null(uuid)

Webhook unique identifier.

organizationstring or null(uuid)
Example: "123e4567-e89b-12d3-a456-426614174000"
userstring or null(uuid)
Example: "123e4567-e89b-12d3-a456-426614174000"
urlstring(uri)<= 500 charactersrequired
https://schema.org/url
secretstring or null
certificateVerificationDisabledboolean or null
enabledboolean
Default true
subscriptionsArray of strings

Webhook subscriptions.

Items Enum"new_document""new_patient""new_contact""new_summary"
Example: ["new_document"]
createdAtstring(date-time)

Webhook creation date.

updatedAtstring(date-time)

Webhook update date.

Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "url": "http://example.com",
  "secret": "string",
  "certificateVerificationDisabled": true,
  "enabled": true,
  "subscriptions": [
    "new_document"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a webhook.

Request

Use this endpoint to delete a webhook entity.

Path
uuidstringrequired

Webhook identifier

curl -i -X DELETE \
  'https://api.askara.ai/webhooks/{uuid}'

Responses

Webhook resource deleted

Response
No content

Patch a webhook.

Request

Use this endpoint to update a webhook entity.

Path
uuidstringrequired

Webhook identifier

Bodyapplication/merge-patch+jsonrequired

The updated Webhook resource

urlstring(uri)<= 500 characters
https://schema.org/url
certificateVerificationDisabledboolean or null
enabledboolean
Default true
subscriptionsArray of strings

Webhook subscriptions.

Items Enum"new_document""new_patient""new_contact""new_summary"
Example: ["new_document"]
curl -i -X PATCH \
  'https://api.askara.ai/webhooks/{uuid}' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "url": "http://example.com",
    "certificateVerificationDisabled": true,
    "enabled": true,
    "subscriptions": [
      "new_document"
    ]
  }'

Responses

Webhook resource updated

Body
uuidstring or null(uuid)

Webhook unique identifier.

organizationstring or null(uuid)
Example: "123e4567-e89b-12d3-a456-426614174000"
userstring or null(uuid)
Example: "123e4567-e89b-12d3-a456-426614174000"
urlstring(uri)<= 500 charactersrequired
https://schema.org/url
secretstring or null
certificateVerificationDisabledboolean or null
enabledboolean
Default true
subscriptionsArray of strings

Webhook subscriptions.

Items Enum"new_document""new_patient""new_contact""new_summary"
Example: ["new_document"]
createdAtstring(date-time)

Webhook creation date.

updatedAtstring(date-time)

Webhook update date.

Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "url": "http://example.com",
  "secret": "string",
  "certificateVerificationDisabled": true,
  "enabled": true,
  "subscriptions": [
    "new_document"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}