POST /webhooks.json

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
POST /webhooks.json 
curl \
 -X POST http://api.example.com/v1/webhooks.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"error":0,"hash":"string","instanceMethod":"string","instanceMethodTrigger":"after","location":"string","resource":"string","success":0,"updateInstance":true,"webhookType":"save"}'
Request example 
{
  "error": 0,
  "hash": "string",
  "instanceMethod": "string",
  "instanceMethodTrigger": "after",
  "location": "string",
  "resource": "string",
  "success": 0,
  "updateInstance": true,
  "webhookType": "save"
}
Response examples (200) 
{
  "createdAt": "2024-05-04T09:42:00+00:00",
  "error": 0,
  "hash": "string",
  "id": 42,
  "instanceMethod": "string",
  "instanceMethodTrigger": "after",
  "location": "string",
  "resource": "string",
  "success": 0,
  "updateInstance": true,
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "webhookType": "save"
}