notification.services.rehive.io Open in urlscan Pro
2606:4700:10::ac43:2857 Public Scan

Back to summary
URL:
https://notification.services.rehive.io/
Submission: On August 27 via automatic, source certstream-suspicious (August 27th 2024, 10:12:06 am UTC) — Scanned from DE
Form analysis
0 forms found in the DOM

Text Content

 * activate
   * postActivate service
 * admin
   * getRetrieve company
   * putUpdate company
   * patchPartially update company
   * getList credentials
   * postCreate credential
   * getRetrieve credential
   * putUpdate credential
   * patchPartially update credential
   * delDelete credential
   * getList layout templates
   * getRetrieve layout template
   * getList layouts
   * postCreate layout
   * getRetrieve layout
   * putUpdate layout
   * patchPartially update layout
   * delDelete layout
   * getList logs
   * getRetrieve log
   * postSend notification
   * getList notifications
   * postCreate notification
   * getRetrieve notification
   * putUpdate notification
   * patchPartially update notification
   * delDelete notification
   * postTrigger notification
   * getList templates
   * getRetrieve template
   * postReceive Platform webhook
 * deactivate
   * postDeactivate service
 * user
   * getList notifications
   * getRetrieve notification
   * putUpdate notification
   * patchPartially update notification

API docs by Redocly



NOTIFICATION SERVICE API (1 (1))

Download OpenAPI specification:Download

Rehive Support: support@rehive.com URL: https://rehive.com/support/ Terms of
Service


The Notification Service API is used for sending email, SMS, and push
notifications in Rehive.

Docs portal


ACTIVATE


ACTIVATE SERVICE

AUTHORIZATIONS:

None

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



token
required
string



RESPONSES

200
post/activate/
https://notification.services.rehive.com/api/activate/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "token": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}


ADMIN


RETRIEVE COMPANY

AUTHORIZATIONS:

apiAuth


RESPONSES

200
get/admin/company/
https://notification.services.rehive.com/api/admin/company/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
    * "system_email": "string",
    * "bimi_selector_header": "string",
    * "name": "string",
    * "push_enabled": true,
    * "quotas": {
       * "sms": 0,
       * "email": 0
      
      },
    * "mode": "test"
   
   }

}


UPDATE COMPANY

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



name
required
string

system_email
required
string

bimi_selector_header
string or null <= 50 characters

push_enabled
boolean



RESPONSES

200
put/admin/company/
https://notification.services.rehive.com/api/admin/company/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "system_email": "string",
 * "bimi_selector_header": "string",
 * "name": "string",
 * "push_enabled": true

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
    * "system_email": "string",
    * "bimi_selector_header": "string",
    * "name": "string",
    * "push_enabled": true,
    * "quotas": {
       * "sms": 0,
       * "email": 0
      
      },
    * "mode": "test"
   
   }

}


PARTIALLY UPDATE COMPANY

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



system_email
string

bimi_selector_header
string or null <= 50 characters

name
string

push_enabled
boolean



RESPONSES

200
patch/admin/company/
https://notification.services.rehive.com/api/admin/company/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "system_email": "string",
 * "bimi_selector_header": "string",
 * "name": "string",
 * "push_enabled": true

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
    * "system_email": "string",
    * "bimi_selector_header": "string",
    * "name": "string",
    * "push_enabled": true,
    * "quotas": {
       * "sms": 0,
       * "email": 0
      
      },
    * "mode": "test"
   
   }

}


LIST CREDENTIALS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.


RESPONSES

200
get/admin/credentials/
https://notification.services.rehive.com/api/admin/credentials/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": 0,
          * "credential_type": "twilio",
          * "credentials": {
             * "property1": null,
             * "property2": null
            
            },
          * "created": 0,
          * "updated": 0
         
         }
      
      ]
   
   }

}


CREATE CREDENTIAL

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



credential_type
required
string
Enum: "twilio" "sendgrid"
 * twilio - twilio
 * sendgrid - sendgrid

credentials
object



RESPONSES

201
post/admin/credentials/
https://notification.services.rehive.com/api/admin/credentials/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
 * "credential_type": "twilio",
 * "credentials": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "credential_type": "twilio",
    * "credentials": {
       * "property1": null,
       * "property2": null
      
      },
    * "created": 0,
    * "updated": 0
   
   }

}


RETRIEVE CREDENTIAL

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

credential_id
required
string^.*$



RESPONSES

200
get/admin/credentials/{credential_id}/
https://notification.services.rehive.com/api/admin/credentials/{credential_id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "credential_type": "twilio",
    * "credentials": {
       * "property1": null,
       * "property2": null
      
      },
    * "created": 0,
    * "updated": 0
   
   }

}


UPDATE CREDENTIAL

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

credential_id
required
string^.*$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



credential_type
required
string
Enum: "twilio" "sendgrid"
 * twilio - twilio
 * sendgrid - sendgrid

credentials
object



RESPONSES

200
put/admin/credentials/{credential_id}/
https://notification.services.rehive.com/api/admin/credentials/{credential_id}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
 * "credential_type": "twilio",
 * "credentials": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "credential_type": "twilio",
    * "credentials": {
       * "property1": null,
       * "property2": null
      
      },
    * "created": 0,
    * "updated": 0
   
   }

}


PARTIALLY UPDATE CREDENTIAL

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

credential_id
required
string^.*$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



credential_type
string
Enum: "twilio" "sendgrid"
 * twilio - twilio
 * sendgrid - sendgrid

credentials
object



RESPONSES

200
patch/admin/credentials/{credential_id}/
https://notification.services.rehive.com/api/admin/credentials/{credential_id}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
 * "credential_type": "twilio",
 * "credentials": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "credential_type": "twilio",
    * "credentials": {
       * "property1": null,
       * "property2": null
      
      },
    * "created": 0,
    * "updated": 0
   
   }

}


DELETE CREDENTIAL

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

credential_id
required
string^.*$



RESPONSES

200
delete/admin/credentials/{credential_id}/
https://notification.services.rehive.com/api/admin/credentials/{credential_id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "credential_type": "twilio",
    * "credentials": {
       * "property1": null,
       * "property2": null
      
      },
    * "created": 0,
    * "updated": 0
   
   }

}


LIST LAYOUT TEMPLATES

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

name
string

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

type
string



RESPONSES

200
get/admin/layout-templates/
https://notification.services.rehive.com/api/admin/layout-templates/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "name": "string",
          * "description": "string",
          * "type": "email",
          * "html_layout": "string",
          * "text_layout": "string",
          * "sms_layout": "string",
          * "push_layout": "string",
          * "created": 0,
          * "updated": 0
         
         }
      
      ]
   
   }

}


RETRIEVE LAYOUT TEMPLATE

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

id
required
string^.*$



RESPONSES

200
get/admin/layout-templates/{id}/
https://notification.services.rehive.com/api/admin/layout-templates/{id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "name": "string",
    * "description": "string",
    * "type": "email",
    * "html_layout": "string",
    * "text_layout": "string",
    * "sms_layout": "string",
    * "push_layout": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


LIST LAYOUTS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

name
string

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

type
string



RESPONSES

200
get/admin/layouts/
https://notification.services.rehive.com/api/admin/layouts/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "name": "string",
          * "description": "string",
          * "type": "email",
          * "html_layout": "string",
          * "text_layout": "string",
          * "sms_layout": "string",
          * "push_layout": "string",
          * "created": 0,
          * "updated": 0
         
         }
      
      ]
   
   }

}


CREATE LAYOUT

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



name
required
string <= 30 characters

type
required
string
Enum: "email" "sms" "push"
 * email - email
 * sms - sms
 * push - push

description
string or null <= 100 characters

html_layout
string or null

text_layout
string or null

sms_layout
string or null

push_layout
string or null



RESPONSES

201
post/admin/layouts/
https://notification.services.rehive.com/api/admin/layouts/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "name": "string",
 * "description": "string",
 * "type": "email",
 * "html_layout": "string",
 * "text_layout": "string",
 * "sms_layout": "string",
 * "push_layout": "string"

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "name": "string",
    * "description": "string",
    * "type": "email",
    * "html_layout": "string",
    * "text_layout": "string",
    * "sms_layout": "string",
    * "push_layout": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


RETRIEVE LAYOUT

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

id
required
string^.*$



RESPONSES

200
get/admin/layouts/{id}/
https://notification.services.rehive.com/api/admin/layouts/{id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "name": "string",
    * "description": "string",
    * "type": "email",
    * "html_layout": "string",
    * "text_layout": "string",
    * "sms_layout": "string",
    * "push_layout": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


UPDATE LAYOUT

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

id
required
string^.*$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



name
required
string <= 30 characters

type
required
string
Enum: "email" "sms" "push"
 * email - email
 * sms - sms
 * push - push

description
string or null <= 100 characters

html_layout
string or null

text_layout
string or null

sms_layout
string or null

push_layout
string or null



RESPONSES

200
put/admin/layouts/{id}/
https://notification.services.rehive.com/api/admin/layouts/{id}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "name": "string",
 * "description": "string",
 * "type": "email",
 * "html_layout": "string",
 * "text_layout": "string",
 * "sms_layout": "string",
 * "push_layout": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "name": "string",
    * "description": "string",
    * "type": "email",
    * "html_layout": "string",
    * "text_layout": "string",
    * "sms_layout": "string",
    * "push_layout": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


PARTIALLY UPDATE LAYOUT

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

id
required
string^.*$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



name
string <= 30 characters

description
string or null <= 100 characters

type
string
Enum: "email" "sms" "push"
 * email - email
 * sms - sms
 * push - push

html_layout
string or null

text_layout
string or null

sms_layout
string or null

push_layout
string or null



RESPONSES

200
patch/admin/layouts/{id}/
https://notification.services.rehive.com/api/admin/layouts/{id}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "name": "string",
 * "description": "string",
 * "type": "email",
 * "html_layout": "string",
 * "text_layout": "string",
 * "sms_layout": "string",
 * "push_layout": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "name": "string",
    * "description": "string",
    * "type": "email",
    * "html_layout": "string",
    * "text_layout": "string",
    * "sms_layout": "string",
    * "push_layout": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


DELETE LAYOUT

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

id
required
string^.*$



RESPONSES

200
delete/admin/layouts/{id}/
https://notification.services.rehive.com/api/admin/layouts/{id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "name": "string",
    * "description": "string",
    * "type": "email",
    * "html_layout": "string",
    * "text_layout": "string",
    * "sms_layout": "string",
    * "push_layout": "string",
    * "created": 0,
    * "updated": 0
   
   }

}


LIST LOGS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

created__gt
string <date-time>

created__lt
string <date-time>

notification
string

notification__name
string

notification__name__contains
string

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

recipient
string

recipient__contains
string

sent
boolean



RESPONSES

200
get/admin/logs/
https://notification.services.rehive.com/api/admin/logs/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": 0,
          * "notification": "string",
          * "type": "email",
          * "user": "string",
          * "recipient": "string",
          * "text_message": "string",
          * "html_message": "string",
          * "sms_message": "string",
          * "sent": true,
          * "error_message": "string",
          * "created": 0
         
         }
      
      ]
   
   }

}


RETRIEVE LOG

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

log_id
required
string^.*$



RESPONSES

200
get/admin/logs/{log_id}/
https://notification.services.rehive.com/api/admin/logs/{log_id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "notification": "string",
    * "type": "email",
    * "user": "string",
    * "recipient": "string",
    * "text_message": "string",
    * "html_message": "string",
    * "sms_message": "string",
    * "sent": true,
    * "error_message": "string",
    * "created": 0
   
   }

}


SEND NOTIFICATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

log_id
required
string^.*$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



recipient
string



RESPONSES

200
post/admin/logs/{log_id}/send/
https://notification.services.rehive.com/api/admin/logs/{log_id}/send/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "recipient": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}


LIST NOTIFICATIONS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

event
string

layout
string

name
string

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

type
string



RESPONSES

200
get/admin/notifications/
https://notification.services.rehive.com/api/admin/notifications/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": 0,
          * "type": "email",
          * "template": {
             * "id": "string",
             * "default": true,
             * "deletable": true
            
            },
          * "name": "string",
          * "subject": "string",
          * "description": "string",
          * "company": "string",
          * "html_message": "string",
          * "text_message": "string",
          * "sms_message": "string",
          * "push_message": "string",
          * "enabled": true,
          * "preference_enabled": true,
          * "event": "string",
          * "to_email": "string",
          * "to_mobile": "string",
          * "to_user": "string",
          * "expression": "string",
          * "from_email": "user@example.com",
          * "layout": {
             * "id": "string",
             * "name": "string",
             * "description": "string",
             * "created": 0,
             * "updated": 0
            
            }
         
         }
      
      ]
   
   }

}


CREATE NOTIFICATION

AUTHORIZATIONS:

apiAuth

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



name
required
string <= 250 characters

type
string or null
Enum: "email" "sms" "push" "" null
 * email - email
 * sms - sms
 * push - push

template
string or null

subject
string or null <= 250 characters

description
string or null <= 250 characters

html_message
string or null

text_message
string or null

sms_message
string or null <= 300 characters

push_message
string or null <= 300 characters

enabled
boolean

preference_enabled
boolean

event
string or null

to_email
string or null <= 150 characters

to_mobile
string or null <= 150 characters

to_user
string or null <= 150 characters

expression
string or null <= 250 characters

from_email
string or null <email> <= 250 characters

layout
string or null



RESPONSES

201
post/admin/notifications/
https://notification.services.rehive.com/api/admin/notifications/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "type": "email",
 * "template": "string",
 * "name": "string",
 * "subject": "string",
 * "description": "string",
 * "html_message": "string",
 * "text_message": "string",
 * "sms_message": "string",
 * "push_message": "string",
 * "enabled": true,
 * "preference_enabled": true,
 * "event": "string",
 * "to_email": "string",
 * "to_mobile": "string",
 * "to_user": "string",
 * "expression": "string",
 * "from_email": "user@example.com",
 * "layout": "string"

}


RESPONSE SAMPLES

 * 201

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "type": "email",
    * "template": {
       * "id": "string",
       * "default": true,
       * "deletable": true
      
      },
    * "name": "string",
    * "subject": "string",
    * "description": "string",
    * "company": "string",
    * "html_message": "string",
    * "text_message": "string",
    * "sms_message": "string",
    * "push_message": "string",
    * "enabled": true,
    * "preference_enabled": true,
    * "event": "string",
    * "to_email": "string",
    * "to_mobile": "string",
    * "to_user": "string",
    * "expression": "string",
    * "from_email": "user@example.com",
    * "layout": {
       * "id": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0
      
      }
   
   }

}


RETRIEVE NOTIFICATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

notification_id
required
string^.*$



RESPONSES

200
get/admin/notifications/{notification_id}/
https://notification.services.rehive.com/api/admin/notifications/{notification_id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "type": "email",
    * "template": {
       * "id": "string",
       * "default": true,
       * "deletable": true
      
      },
    * "name": "string",
    * "subject": "string",
    * "description": "string",
    * "company": "string",
    * "html_message": "string",
    * "text_message": "string",
    * "sms_message": "string",
    * "push_message": "string",
    * "enabled": true,
    * "preference_enabled": true,
    * "event": "string",
    * "to_email": "string",
    * "to_mobile": "string",
    * "to_user": "string",
    * "expression": "string",
    * "from_email": "user@example.com",
    * "layout": {
       * "id": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0
      
      }
   
   }

}


UPDATE NOTIFICATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

notification_id
required
string^.*$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



name
required
string <= 250 characters

type
string or null
Enum: "email" "sms" "push" "" null
 * email - email
 * sms - sms
 * push - push

template
string or null

subject
string or null <= 250 characters

description
string or null <= 250 characters

html_message
string or null

text_message
string or null

sms_message
string or null <= 300 characters

push_message
string or null <= 300 characters

enabled
boolean

preference_enabled
boolean

event
string or null

to_email
string or null <= 150 characters

to_mobile
string or null <= 150 characters

to_user
string or null <= 150 characters

expression
string or null <= 250 characters

from_email
string or null <email> <= 250 characters

layout
string or null



RESPONSES

200
put/admin/notifications/{notification_id}/
https://notification.services.rehive.com/api/admin/notifications/{notification_id}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "type": "email",
 * "template": "string",
 * "name": "string",
 * "subject": "string",
 * "description": "string",
 * "html_message": "string",
 * "text_message": "string",
 * "sms_message": "string",
 * "push_message": "string",
 * "enabled": true,
 * "preference_enabled": true,
 * "event": "string",
 * "to_email": "string",
 * "to_mobile": "string",
 * "to_user": "string",
 * "expression": "string",
 * "from_email": "user@example.com",
 * "layout": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "type": "email",
    * "template": {
       * "id": "string",
       * "default": true,
       * "deletable": true
      
      },
    * "name": "string",
    * "subject": "string",
    * "description": "string",
    * "company": "string",
    * "html_message": "string",
    * "text_message": "string",
    * "sms_message": "string",
    * "push_message": "string",
    * "enabled": true,
    * "preference_enabled": true,
    * "event": "string",
    * "to_email": "string",
    * "to_mobile": "string",
    * "to_user": "string",
    * "expression": "string",
    * "from_email": "user@example.com",
    * "layout": {
       * "id": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0
      
      }
   
   }

}


PARTIALLY UPDATE NOTIFICATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

notification_id
required
string^.*$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



type
string or null
Enum: "email" "sms" "push" "" null
 * email - email
 * sms - sms
 * push - push

template
string or null

name
string <= 250 characters

subject
string or null <= 250 characters

description
string or null <= 250 characters

html_message
string or null

text_message
string or null

sms_message
string or null <= 300 characters

push_message
string or null <= 300 characters

enabled
boolean

preference_enabled
boolean

event
string or null

to_email
string or null <= 150 characters

to_mobile
string or null <= 150 characters

to_user
string or null <= 150 characters

expression
string or null <= 250 characters

from_email
string or null <email> <= 250 characters

layout
string or null



RESPONSES

200
patch/admin/notifications/{notification_id}/
https://notification.services.rehive.com/api/admin/notifications/{notification_id}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "type": "email",
 * "template": "string",
 * "name": "string",
 * "subject": "string",
 * "description": "string",
 * "html_message": "string",
 * "text_message": "string",
 * "sms_message": "string",
 * "push_message": "string",
 * "enabled": true,
 * "preference_enabled": true,
 * "event": "string",
 * "to_email": "string",
 * "to_mobile": "string",
 * "to_user": "string",
 * "expression": "string",
 * "from_email": "user@example.com",
 * "layout": "string"

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "type": "email",
    * "template": {
       * "id": "string",
       * "default": true,
       * "deletable": true
      
      },
    * "name": "string",
    * "subject": "string",
    * "description": "string",
    * "company": "string",
    * "html_message": "string",
    * "text_message": "string",
    * "sms_message": "string",
    * "push_message": "string",
    * "enabled": true,
    * "preference_enabled": true,
    * "event": "string",
    * "to_email": "string",
    * "to_mobile": "string",
    * "to_user": "string",
    * "expression": "string",
    * "from_email": "user@example.com",
    * "layout": {
       * "id": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0
      
      }
   
   }

}


DELETE NOTIFICATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

notification_id
required
string^.*$



RESPONSES

200
delete/admin/notifications/{notification_id}/
https://notification.services.rehive.com/api/admin/notifications/{notification_id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "type": "email",
    * "template": {
       * "id": "string",
       * "default": true,
       * "deletable": true
      
      },
    * "name": "string",
    * "subject": "string",
    * "description": "string",
    * "company": "string",
    * "html_message": "string",
    * "text_message": "string",
    * "sms_message": "string",
    * "push_message": "string",
    * "enabled": true,
    * "preference_enabled": true,
    * "event": "string",
    * "to_email": "string",
    * "to_mobile": "string",
    * "to_user": "string",
    * "expression": "string",
    * "from_email": "user@example.com",
    * "layout": {
       * "id": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0
      
      }
   
   }

}


TRIGGER NOTIFICATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

notification_id
required
string^.*$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



data
object or null



RESPONSES

200
post/admin/notifications/{notification_id}/trigger/
https://notification.services.rehive.com/api/admin/notifications/{notification_id}/trigger/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
 * "data": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}


LIST TEMPLATES

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

event
string

layout
string

name
string

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

type
string



RESPONSES

200
get/admin/templates/
https://notification.services.rehive.com/api/admin/templates/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": "string",
          * "type": "email",
          * "name": "string",
          * "subject": "string",
          * "description": "string",
          * "html_message": "string",
          * "text_message": "string",
          * "sms_message": "string",
          * "push_message": "string",
          * "enabled": true,
          * "preference_enabled": true,
          * "event": "string",
          * "to_email": "string",
          * "to_mobile": "string",
          * "to_user": "string",
          * "expression": "string",
          * "layout": {
             * "id": "string",
             * "name": "string",
             * "description": "string",
             * "created": 0,
             * "updated": 0
            
            },
          * "default": true,
          * "deletable": true,
          * "created": 0,
          * "updated": 0
         
         }
      
      ]
   
   }

}


RETRIEVE TEMPLATE

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

template_id
required
string^.*$



RESPONSES

200
get/admin/templates/{template_id}/
https://notification.services.rehive.com/api/admin/templates/{template_id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": "string",
    * "type": "email",
    * "name": "string",
    * "subject": "string",
    * "description": "string",
    * "html_message": "string",
    * "text_message": "string",
    * "sms_message": "string",
    * "push_message": "string",
    * "enabled": true,
    * "preference_enabled": true,
    * "event": "string",
    * "to_email": "string",
    * "to_mobile": "string",
    * "to_user": "string",
    * "expression": "string",
    * "layout": {
       * "id": "string",
       * "name": "string",
       * "description": "string",
       * "created": 0,
       * "updated": 0
      
      },
    * "default": true,
    * "deletable": true,
    * "created": 0,
    * "updated": 0
   
   }

}


RECEIVE PLATFORM WEBHOOK

AUTHORIZATIONS:

None

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



company
required
string

data
required
object

event
required
string

id
required
string



RESPONSES

200
post/admin/webhook/
https://notification.services.rehive.com/api/admin/webhook/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
 * "id": "string",
 * "event": "string",
 * "company": "string",
 * "data": {
    * "property1": null,
    * "property2": null
   
   }

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}


DEACTIVATE


DEACTIVATE SERVICE

AUTHORIZATIONS:

None

REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



token
required
string

purge
boolean
Default: false



RESPONSES

200
post/deactivate/
https://notification.services.rehive.com/api/deactivate/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "token": "string",
 * "purge": false

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
{
 * "status": "sucess"

}


USER


LIST NOTIFICATIONS

AUTHORIZATIONS:

apiAuth

QUERY PARAMETERS

event
string

layout
string

name
string

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

type
string



RESPONSES

200
get/user/notifications/
https://notification.services.rehive.com/api/user/notifications/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "count": 123,
    * "next": "http://api.example.org/accounts/?page=4",
    * "previous": "http://api.example.org/accounts/?page=2",
    * "results": [
       * {
          * "id": 0,
          * "name": "string",
          * "description": "string",
          * "event": "string",
          * "type": "string",
          * "enabled": true
         
         }
      
      ]
   
   }

}


RETRIEVE NOTIFICATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

notification_id
required
string^.*$



RESPONSES

200
get/user/notifications/{notification_id}/
https://notification.services.rehive.com/api/user/notifications/{notification_id}/


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "name": "string",
    * "description": "string",
    * "event": "string",
    * "type": "string",
    * "enabled": true
   
   }

}


UPDATE NOTIFICATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

notification_id
required
string^.*$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



enabled
required
boolean



RESPONSES

200
put/user/notifications/{notification_id}/
https://notification.services.rehive.com/api/user/notifications/{notification_id}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "enabled": true

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "name": "string",
    * "description": "string",
    * "event": "string",
    * "type": "string",
    * "enabled": true
   
   }

}


PARTIALLY UPDATE NOTIFICATION

AUTHORIZATIONS:

apiAuth

PATH PARAMETERS

notification_id
required
string^.*$


REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON



enabled
boolean



RESPONSES

200
patch/user/notifications/{notification_id}/
https://notification.services.rehive.com/api/user/notifications/{notification_id}/


REQUEST SAMPLES

 * Payload

Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
 * "enabled": true

}


RESPONSE SAMPLES

 * 200

Content type
application/json
Copy
Expand all Collapse all
{
 * "status": "success",
 * "data": {
    * "id": 0,
    * "name": "string",
    * "description": "string",
    * "event": "string",
    * "type": "string",
    * "enabled": true
   
   }

}
notification.services.rehive.io Open in urlscan Pro 2606:4700:10::ac43:2857 Public Scan

Form analysis 0 forms found in the DOM

Text Content

notification.services.rehive.io Open in urlscan Pro
2606:4700:10::ac43:2857 Public Scan

Form analysis
0 forms found in the DOM
