Webhookah API (1.0.0)

Download OpenAPI specification:

Public HTTP API for webhook testing. Authenticate with an API key (Authorization: Bearer wh-...). Receive URLs under /wh/{token} do not use an API key.

Endpoints

Manages webhook endpoints

List all webhook endpoints

Authorizations:

bearerAuth

Responses

Response samples

200
401
500

Content type

application/json

[{"id": 1,
"url": "https://webhookah.com/wh/alpha-artemis-5aa3d2fc",
"token": "alpha-artemis-5aa3d2fc",
"createdAt": "2019-08-24T14:15:22Z",
"badgeName": "alpha"
}
]

Create new webhook endpoint

Create new webhook endpoint, no args needed

Authorizations:

bearerAuth

Responses

Response samples

201
401
403
500

Content type

application/json

{"id": 1,
"url": "https://webhookah.com/wh/alpha-artemis-5aa3d2fc",
"token": "alpha-artemis-5aa3d2fc",
"createdAt": "2019-08-24T14:15:22Z",
"badgeName": "alpha"
}

Regenerate webhook URLs

Deletes all current endpoints and creates a new one

Authorizations:

bearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"id": 1,
"url": "https://webhookah.com/wh/alpha-artemis-5aa3d2fc",
"token": "alpha-artemis-5aa3d2fc",
"createdAt": "2019-08-24T14:15:22Z",
"badgeName": "alpha"
}

Update endpoint

Update endpoint configuration

Authorizations:

bearerAuth

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Request Body schema: application/json

badgeName

string

Name of the badge to display for the webhook

Responses

Request samples

Payload

Content type

application/json

{"badgeName": "alpha"
}

Response samples

200
400
401
404
500

Content type

application/json

{"id": 1,
"url": "https://webhookah.com/wh/alpha-artemis-5aa3d2fc",
"token": "alpha-artemis-5aa3d2fc",
"createdAt": "2019-08-24T14:15:22Z",
"badgeName": "alpha"
}

Delete endpoint

Authorizations:

bearerAuth

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Responses

Response samples

401
404
500

Content type

application/json

{"error": "string"
}

List all webhook requests for user

Authorizations:

bearerAuth

Responses

Response samples

200
401
500

Content type

application/json

[{"id": 0,
"method": "string",
"headers": {"property1": "string",
"property2": "string"
},
"body": {"json": { },
"xml": "string",
"raw": "string"
},
"queryParams": {"property1": "string",
"property2": "string"
},
"ipAddress": "string",
"receivedAt": "2019-08-24T14:15:22Z",
"endpointId": 0
}
]

Clear all webhook requests for all endpoints

Authorizations:

bearerAuth

Responses

Response samples

401
500

Content type

application/json

{"error": "string"
}

List webhook requests for specific endpoint

Authorizations:

bearerAuth

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Responses

Response samples

200
401
404
500

Content type

application/json

[{"id": 0,
"method": "string",
"headers": {"property1": "string",
"property2": "string"
},
"body": {"json": { },
"xml": "string",
"raw": "string"
},
"queryParams": {"property1": "string",
"property2": "string"
},
"ipAddress": "string",
"receivedAt": "2019-08-24T14:15:22Z",
"endpointId": 0
}
]

Clear webhook requests for specific endpoint

Authorizations:

bearerAuth

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Responses

Response samples

401
404
500

Content type

application/json

{"error": "string"
}

Server-sent events for real-time updates

Authorizations:

bearerAuth

Responses

Response samples

401
500

Content type

application/json

{"error": "string"
}

Webhooks

Endpoints for receiving webhooks

Receive webhook GET request

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Responses

Response samples

200
404
500

Content type

application/json

{"id": 0,
"message": "string"
}

Receive webhook POST request

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Request Body schema: /

string

Responses

Response samples

200
404
500

Content type

application/json

{"id": 0,
"message": "string"
}

Receive webhook PUT request

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Request Body schema: /

string

Responses

Response samples

200
404
500

Content type

application/json

{"id": 0,
"message": "string"
}

Receive webhook PATCH request

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Request Body schema: /

string

Responses

Response samples

200
404
500

Content type

application/json

{"id": 0,
"message": "string"
}

Receive webhook DELETE request

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Responses

Response samples

200
404
500

Content type

application/json

{"id": 0,
"message": "string"
}

Receive webhook OPTIONS request

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Responses

Response samples

200
404
500

Content type

application/json

{"id": 0,
"message": "string"
}

Receive webhook HEAD request

path Parameters

endpointToken

required

string

Example: alpha-artemis-5aa3d2fc

Token of the endpoint

Responses

Response samples

200
404
500

Content type

application/json

{"id": 0,
"message": "string"
}

Auth

Authentication and session management

Current user

Returns the current session principal (guest or registered)

Authorizations:

bearerAuth

Responses

Response samples

200
401
500

Content type

application/json

{"id": 0,
"email": "string",
"isGuest": true,
"plan": "plus",
"subscriptionId": "string",
"price": "string",
"currency": "string",
"dateStart": "2019-08-24T14:15:22Z",
"dateEnd": "2019-08-24T14:15:22Z",
"datePurchase": "2019-08-24T14:15:22Z",
"status": "active"
}

Webhookah API (1.0.0)

Endpoints

List all webhook endpoints

Authorizations:

Responses

Response samples

Create new webhook endpoint

Authorizations:

Responses

Response samples

Regenerate webhook URLs

Authorizations:

Responses

Response samples

Update endpoint

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete endpoint

Authorizations:

path Parameters

Responses

Response samples

List all webhook requests for user

Authorizations:

Responses

Response samples

Clear all webhook requests for all endpoints

Authorizations:

Responses

Response samples

List webhook requests for specific endpoint

Authorizations:

path Parameters

Responses

Response samples

Clear webhook requests for specific endpoint

Authorizations:

path Parameters

Responses

Response samples

Server-sent events for real-time updates

Authorizations:

Responses

Response samples

Webhooks

Receive webhook GET request

path Parameters

Responses

Response samples

Receive webhook POST request

path Parameters

Request Body schema: */*

Responses

Response samples

Receive webhook PUT request

path Parameters

Request Body schema: */*

Responses

Response samples

Receive webhook PATCH request

path Parameters

Request Body schema: */*

Responses

Response samples

Receive webhook DELETE request

path Parameters

Responses

Response samples

Receive webhook OPTIONS request

path Parameters

Responses

Response samples

Receive webhook HEAD request

path Parameters

Responses

Response samples

Request Body schema: /

Request Body schema: /

Request Body schema: /