Skip to main content

Webhook Documentation

A webhook is a simple and efficient way to connect notifications to your system. Instead of periodically polling an API for new data, the webhook allows you to receive real-time updates as soon as the data changes in Uniskai.

Updated over a month ago

Events

When Event will happen, we will send you a POST Request with a payload when the event happens. In addition, there will be information about the notification.

There are available notification types:

Permission request from team member

Response Structure

  • type: "team-member-permission-request"

  • provider: string

  • account_id: string

  • account_name: string — for receiver (owner of environment)

  • environment_id: integer — for receiver (owner of environment)

  • requester_name: string

  • permissions: list[dict]

    • service: string — Cloudsitter, Spot, Savings, etc

    • mode: string — Was withdrawn | Read | Read/write

Response Example

{
  "type":"team-member-permission-request",
  "provider":"AWS",
  "account_id":"12345678",
  "account_name":"Development Account",
  "environment_id":42,
  "requester_name":"John Doe",
  "permissions":[
    {
      "service":"Cloudsitter",
      "mode":"Read/write"
    },
    {
      "service":"Rightsizing",
      "mode":"Read/write"
    }
  ]
}

Spot recreation

Response Structure

  • type: "spot-recreated"

  • resources: list[dict]

    • name: string

    • type: string

    • region: string

    • vpc: string | null

Response Example

{
  "type":"spot-recreated",
  "resources":[
    {
      "name":"i-0abc12d345ef678",
      "type":"ec2-spot-instance",
      "region":"eu-central-1",
      "vpc":"vpc-12a345bc"
    }
  ]
}

Spot back to on-demand

Response Structure

  • type: "spot-rollback"

  • resources: list[dict]

    • name: string

    • type: string

    • region: string

    • vpc: string | null

Response Example

{
  "type":"spot-rollback",
  "resources":[
    {
      "name":"i-0abc12d345ef678",
      "type":"ec2-spot-instance",
      "region":"eu-central-1",
      "vpc":"default"
    }
  ]
}

Policy changed state of some resource

Response Structure

  • type: "cloudsitter-start-stop"

  • policy_name: string

  • stopped/started: list[dict]

    • account_id: string

    • type: string

    • rn: string

    • name: string

    • region: string

Response Example

{
"type": "cloudsitter-start-stop", 
"policy_name": "new policy", 
"stopped": [
  {
     "account_id": "111111111111", 
     "type": "ecs-autoscaling-group", 
     "rn": "arn:aws:", 
     "name": "ECS Instance", 
     "region": "ap-southeast-2"
  }
 ]
}

Policy update failure

Response Structure

  • type: "cloudsitter-policy-failed"

  • resources: list[dict]

    • name: string

    • type: string

    • region: string

    • error: string

  • failed_action: string — on | off

Response Example

{
  "type":"cloudsitter-policy-failed",
  "resources":[
    {
      "name":"i-0abc12d345ef678",
      "type":"Instance",
      "region":"eu-central-1",
      "error":"You have no permission for managing resources"
    }
  ],
  "failed_action":"on"
}

Trial Period Ending

Response Structure

  • type: "trial-period-ending"

  • accounts: list[dict]

    • account_name: string

    • account_id: string

    • trial_days: string (e.g. "10 days")

    • trial_expired_on: string

Response Example

{
  "type":"trial-period-ending",
  "accounts":[
    {
      "account_name":"Development Account",
      "account_id":"12345678",
      "trial_days":"10 days",
      "trial_expired_on":"Feb 31, 2023"
    }
  ]
}

Trial Period Ended

Response Structure

  • type: "trial-period-ended"

  • accounts: list[dict]

    • account_name: string

    • account_id: string

Response Example

{
  "type":"trial-period-ended",
  "accounts":[
    {
      "account_name":"Development Account",
      "account_id":"12345678"
    }
  ]
}

On-demand back to spot

Response Structure

  • type: "managed-on-demand-back-to-spot"

  • resources: list[dict]

    • name: string

    • type: string

    • region: string

    • vpc: string | null

Response Example

{
  "type":"managed-on-demand-back-to-spot",
  "resources":[
    {
      "name":"i-0abc12d345ef678",
      "type":"ec2-spot-instance",
      "region":"eu-central-1",
      "vpc":"default"
    }
  ]
}

Did this answer your question?