Skip to main content
GET
/
webhook
/
decoda
/
get
/
{webhook_id}
Webhook Get
curl --request GET \
  --url https://api.decodahealth.com/webhook/decoda/get/{webhook_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "id": "<string>",
  "subscriptions": [
    "PATIENT_CREATED"
  ],
  "url": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "secret": "<string>",
  "updatedDate": "2023-11-07T05:31:56Z",
  "notificationEmail": "<string>",
  "isArchived": false
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Path Parameters

​
webhook_id
string
required

Response

Successful Response

​
id
string
required

Unique identifier for the webhook.

​
subscriptions
enum<string>[]
required

List of event types the webhook is subscribed to.

Available options:
PATIENT_CREATED,
PATIENT_UPDATED,
APPOINTMENT_CANCELLED,
APPOINTMENT_UPDATED,
APPOINTMENT_REQUEST,
APPOINTMENT_SCHEDULED,
SELF_SCHEDULED_APPOINTMENT,
SELF_SCHEDULED_APPOINTMENT_CANCELLED,
SELF_SCHEDULED_APPOINTMENT_UPDATED,
BLOCK_CREATED,
BLOCK_CANCELLED,
BLOCK_UPDATED,
SHIFT_CREATED,
SHIFT_CANCELLED,
SHIFT_UPDATED,
PAYMENT_CREATED,
PAYMENT_FAILED,
PAYMENT_SUCCEEDED,
PLANNED_PAYMENT_FAILED,
PLANNED_PAYMENT_SUCCEEDED,
CHARGE_CREATED,
REFUND_CREATED,
REFUND_FAILED,
REFUND_SUCCEEDED,
ADJUSTMENT_CREATED,
ADJUSTMENT_FAILED,
ADJUSTMENT_SUCCEEDED,
INVOICE_UPDATED,
INVOICE_STATUS_UPDATE,
INVOICE_SET_UPDATED,
CHARGE_PAYMENT_CREATED,
CALL_RECEIVED,
CALL_MADE,
CALL_ONGOING,
MESSAGE_RECEIVED,
MESSAGE_SENT,
MESSAGE_DELIVERED,
MESSAGE_FAILED,
EMAIL_RECEIVED,
EMAIL_SENT,
MAIL_SENT,
MAIL_DELIVERY_FAILED,
FORM_SUBMITTED,
NOTIFICATION,
APPOINTMENT_CHECKLIST_UPDATED,
LOW_PATIENT_REVIEW,
CHAT_UPDATE,
RAINFOREST_PAYIN_FAILED,
RAINFOREST_PAYIN_PROCESSING,
RAINFOREST_POS_PAYIN_CANCELLED,
RAINFOREST_DEPOSIT_IN_REVIEW,
RAINFOREST_DEPOSIT_SUCCEEDED,
RAINFOREST_DEPOSIT_FAILED,
STOCK_LOW,
STOCK_ADDED,
STOCK_ARCHIVED,
STOCK_LINKED_TO_ITEM,
STOCK_UNLINKED_FROM_ITEM,
STOCK_UPDATED,
STOCK_DRAWDOWN,
SHIPMENT_RECEIVED,
SHIPMENT_UPDATED,
SHIPMENT_ARCHIVED,
ITEM_CREATED,
ITEM_UPDATED,
ITEM_ARCHIVED,
INVENTORY_ACTION
​
url
string
required

The URL where the webhook sends notifications.

​
createdDate
string<date-time>
required

The date and time when the webhook was created.

​
secret
string
required

The secret key used for signing the webhook payloads.

​
updatedDate
string<date-time> | null

The date and time when the webhook was last updated.

​
notificationEmail
string | null

Email address for sending notifications about delivery failures.

​
isArchived
boolean
default:false

Whether the webhook has been archived.