Appearance
REST API: Webhooks
5 endpoints.
GET /api/v1/rest/events
Event types a hook can subscribe to
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response List Events Api V1 Rest Events Get"
}GET /api/v1/rest/hooks
List this organization's webhook subscriptions
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response List Hooks Api V1 Rest Hooks Get"
}POST /api/v1/rest/hooks
Subscribe (REST hook)
Returns the subscription id (keep it to unsubscribe) and, once only, the signing secret.
Request body
json
{
"properties": {
"target_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Url"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"hookUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Hookurl"
},
"event": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Event"
},
"events": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Events"
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"title": "Description"
}
},
"type": "object",
"title": "HookIn",
"description": "Zapier sends whatever the integration's subscribe request says; Make's\nattach does the same. The three spellings of the URL are all accepted so a\nhand-written HTTP module works without reading these docs first."
}201 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Subscribe Hook Api V1 Rest Hooks Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/rest/hooks/{hook_id}
Unsubscribe (REST hook)
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
hook_id | path | yes | string |
204 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/rest/hooks/{hook_id}/deliveries
Recent deliveries for a subscription
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
hook_id | path | yes | string | |
limit | query | no | integer |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Hook Deliveries Api V1 Rest Hooks Hook Id Deliveries Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}