POST /webhooks.json

application/json

Body Required

error integer(int32) | null Required

Error

Default value is 0.
hash string | null

Hash
instanceMethod string | null

Instance method
instanceMethodTrigger string | null Required

Instance method trigger

Values are before or after. Default value is after.
location string Required

Location
resource string Required

Resource
success integer(int32) | null Required

Success

Default value is 0.
updateInstance boolean | null

Update instance
webhookType string | null Required

Webhook type

Values are save, instanceMethod, or create. Default value is save.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- error integer(int32) | null Required
  
  Error
  
  Default value is 0.
- hash string | null
  
  Hash
- id integer(int32)
  
  Id
- instanceMethod string | null
  
  Instance method
- instanceMethodTrigger string | null Required
  
  Instance method trigger
  
  Values are before or after. Default value is after.
- location string Required
  
  Location
- resource string Required
  
  Resource
- success integer(int32) | null Required
  
  Success
  
  Default value is 0.
- updateInstance boolean | null
  
  Update instance
- updatedAt string(date-time)
  
  Updated at
- webhookType string | null Required
  
  Webhook type
  
  Values are save, instanceMethod, or create. Default value is save.

POST /webhooks.json

curl \
 --request POST 'http://api.example.com/v1/webhooks.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"error":0,"hash":"string","instanceMethod":"string","instanceMethodTrigger":"after","location":"string","resource":"string","success":0,"updateInstance":true,"webhookType":"save"}'

Request examples

{
  "error": 0,
  "hash": "string",
  "instanceMethod": "string",
  "instanceMethodTrigger": "after",
  "location": "string",
  "resource": "string",
  "success": 0,
  "updateInstance": true,
  "webhookType": "save"
}

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "error": 0,
  "hash": "string",
  "id": 42,
  "instanceMethod": "string",
  "instanceMethodTrigger": "after",
  "location": "string",
  "resource": "string",
  "success": 0,
  "updateInstance": true,
  "updatedAt": "2025-05-04T09:42:00Z",
  "webhookType": "save"
}