v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Create

Creates a trigger to send a notification to a customer or endpoint.

post/v1/notifications

Headers

x-user-secret-keystring required

Your API private/secret key. This can be found in the powerboard dashboard.

Content-Typestring required

Content-Type will always be application/json

Request body

typestring required

Type of notification. Available values: 'webhook', 'email'

destinationstring required

Where to send the notification. URL for webhook; email address for email.

eventstring required

Event to trigger a notification

subjectstring

set subject of notification. Email notifications only

transaction_onlyboolean

If true, the payload of an event will include information on the transaction only. The rest fo the fields will be omitted.

Response

200

statusinteger

{"stackTrail":"paths:/v1/notifications:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "status": 201,
  "resource": {
    "type": "notification",
    "data": {
      "event": "transaction_success",
      "destination": "http://hahn.mertz.llc.biz",
      "type": "webhook",
      "_id": "5f58aadf4d9f505928aca28a"
    }
  }
}