POST
/
webhooks
curl --request POST \
  --url https://staging-api.chip-in.asia/api/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checksum: <checksum>' \
  --header 'epoch: <epoch>' \
  --data '{
  "name": "First Webhook",
  "callback_url": "https://yourwebsite.com/route",
  "email": "email@chip-in.asia",
  "event_hooks": [
    [
      "budget_allocation_status",
      "bank_account_status",
      "send_instruction_status"
    ]
  ]
}'
[
  {
    "id": 1,
    "name": "First Webhook",
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA6gLlBKxCB5dxPJbinCzl\nhOfKSgQtOWQQBxmnWIkEVUbqhpnqr3xNYiAvDyMUxYUwuzN44eHO+mR9MZWcSx3c\nbXmKa3gsOzR6GdcOxMGaVxvfje+fujCAlCtO1BP+A9/FS3KcPgCYG1wtAPwA5IAf\nHylL3TsUVIJQFBgiBr6N4Bgapr9eloaFfeYIBRsXmxPKAMJivqxYpLh0V3N4ZFd5\nTGqSEAa4b1ULDr6p0sB2L3QikTdsF0zp03zNceKA6fXDOzD0xWtg9buXvyKwePK4\nM2kcnWBNfsWghrdg0fG3O9bmkaS1oEXydrmJfuiI8h6a64J/1nzooi2yLC9D6Ta0\nS63bbuAHymnQtiNuV7Ixp6IoTGFaS88aTiHaP8rdyWV8JTDFx0qeDzyaGWiYGwEF\nmj/buHCEcRhoajbGkPhYA4YEdn4jy1wZhEr2OMdBPM7mPPI0Hy3hcNJVMVVlrpHe\nIltQATpjlNaJMlRPjbcaiW7dsO3BuF9ZOMGksSOnyYm/AgMBAAE=\n-----END PUBLIC KEY-----",
    "callback_url\"": "https://yourwebsite.com/route",
    "email": "email@chip-in.asia",
    "event_hooks": [
      "bank_account_status",
      "budget_allocation_status",
      "send_instruction_status"
    ],
    "created_at": 16197408,
    "updated_at": 16197408
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
epoch
integer
required

Unix epoch timestamp

Example:

1619740800

​
checksum
string
required

Refer to checksum calculation

Body

application/json

This is webhook schema

​
name
string
required
Example:

"First Webhook"

​
callback_url
string
required
Maximum length: 500
Example:

"https://yourwebsite.com/route"

​
email
string
required
Example:

"email@chip-in.asia"

​
event_hooks
enum<string>[]
required

List of events to trigger webhook callbacks for.

Available event types and when they are emitted:

bank_account_status: Emitted when a Company Bank Account status changed. This happens as a result of CHIP processing the company bank account for verification.

budget_allocation_status: Emitted when a Budget Allocation status changed. This happens as a result of approver approve the increment.

send_instruction_status: Emitted when a Company Send Instructions status changed. This happens as a result of CHIP processing the company send instruction with the banks.

Available options:
bank_account_status,
budget_allocation_status,
send_instruction_status

Response

200
application/json
Successful response

This is webhook schema

​
id
integer
Example:

1

​
name
string
​
public_key
string

PEM-encoded RSA public key for authenticating webhook or callback payloads

Example:

"-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA6gLlBKxCB5dxPJbinCzl\nhOfKSgQtOWQQBxmnWIkEVUbqhpnqr3xNYiAvDyMUxYUwuzN44eHO+mR9MZWcSx3c\nbXmKa3gsOzR6GdcOxMGaVxvfje+fujCAlCtO1BP+A9/FS3KcPgCYG1wtAPwA5IAf\nHylL3TsUVIJQFBgiBr6N4Bgapr9eloaFfeYIBRsXmxPKAMJivqxYpLh0V3N4ZFd5\nTGqSEAa4b1ULDr6p0sB2L3QikTdsF0zp03zNceKA6fXDOzD0xWtg9buXvyKwePK4\nM2kcnWBNfsWghrdg0fG3O9bmkaS1oEXydrmJfuiI8h6a64J/1nzooi2yLC9D6Ta0\nS63bbuAHymnQtiNuV7Ixp6IoTGFaS88aTiHaP8rdyWV8JTDFx0qeDzyaGWiYGwEF\nmj/buHCEcRhoajbGkPhYA4YEdn4jy1wZhEr2OMdBPM7mPPI0Hy3hcNJVMVVlrpHe\nIltQATpjlNaJMlRPjbcaiW7dsO3BuF9ZOMGksSOnyYm/AgMBAAE=\n-----END PUBLIC KEY-----"

​
callback_url
string
Maximum length: 500
Example:

"https://yourwebsite.com/route"

​
email
string
​
event_hooks
enum<string>[]

List of events to trigger webhook callbacks for.

Available event types and when they are emitted:

bank_account_status: Emitted when a Company Bank Account status changed. This happens as a result of CHIP processing the company bank account for verification.

budget_allocation_status: Emitted when a Budget Allocation status changed. This happens as a result of approver approve the increment.

send_instruction_status: Emitted when a Company Send Instructions status changed. This happens as a result of CHIP processing the company send instruction with the banks.

Available options:
bank_account_status,
budget_allocation_status,
send_instruction_status
​
created_at
string

Object creation time in UTC

​
updated_at
string

Object creation time in UTC