Webhook Example

This is the documentation for version 1.0.0 of the API. Last update on Feb 17, 2021.

Base URL
http://api.example.com

Pets

List all pets

Query parameters
  • limit integer(int32)

    How many items to return at one time (max 100)

Responses
  • 200 array[object]

    A paged array of pets

    • id Required / integer(int64)
    • name Required / string
    • tag string
GET /pets
$ curl \
 -X GET http://api.example.com/pets
Response example (200)
[
  {
    "id": 42,
    "name": "string",
    "tag": "string"
  }
]

New pet

A new pet arrived

A new pet arrived, let's come and discover it IRL.

Body
  • id Required / integer(int64)
  • name Required / string
  • tag string
Responses
  • 200

    Return a 200 status to indicate that the data was received successfully

POST newPet
$ curl \
 -X POST https://webhook.example.com \
 -d '{"id":42,"name":"string","tag":"string"}'
Request example
{
  "id": 42,
  "name": "string",
  "tag": "string"
}