Rehive logo
Powered by Redocly

webhooks

List webhooks

SecurityapiAuth
Request
query Parameters
event
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

secret
string
url
string
Responses
200
get/3/admin/webhooks/
Request samples 
rehive.admin.webhooks.get().then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{}

Create webhook

SecurityapiAuth
Request
Request Body schema:
required
url
required
string <uri>
event
required
string
  • company.link.create - Company Link Create
  • company.link.update - Company Link Update
  • currency.create - Currency Create
  • currency.update - Currency Update
  • user.create - User Create
  • user.update - User Update
  • user.password.reset - User Password Reset
  • user.password.set - User Password Set
  • user.deactivate.verify - User Deactivate Verify
  • user.request_delete.verify - User Request Delete Verify
  • user.email.verify - User Email Verify
  • user.mobile.verify - User Mobile Verify
  • email.create - Email Create
  • email.update - Email Update
  • mobile.create - Mobile Create
  • mobile.update - Mobile Update
  • address.create - Address Create
  • address.update - Address Update
  • document.create - Document Create
  • document.update - Document Update
  • bank_account.create - Bank Account Create
  • bank_account.update - Bank Account Update
  • crypto_account.create - Crypto Account Create
  • crypto_account.update - Crypto Account Update
  • account.create - Account Create
  • account.update - Account Update
  • transaction.create - Transaction Create
  • transaction.update - Transaction Update
  • transaction.initiate - Transaction Initiate
  • transaction.execute - Transaction Execute
  • transaction.transition.create - Transaction Transition Create
  • transaction.transition.update - Transaction Transition Update
  • mfa.sms.verify - Mfa Sms Verify
Enum: "company.link.create" "company.link.update" "currency.create" "currency.update" "user.create" "user.update" "user.password.reset" "user.password.set" "user.deactivate.verify" "user.request_delete.verify" "user.email.verify" "user.mobile.verify" "email.create" "email.update" "mobile.create" "mobile.update" "address.create" "address.update" "document.create" "document.update" "bank_account.create" "bank_account.update" "crypto_account.create" "crypto_account.update" "account.create" "account.update" "transaction.create" "transaction.update" "transaction.initiate" "transaction.execute" "transaction.transition.create" "transaction.transition.update" "mfa.sms.verify"
secret
string <= 250 characters
condition
string or null <= 250 characters
enabled
boolean
archived
boolean
Default: false
Responses
201
post/3/admin/webhooks/
Request samples
{
  • "url": "http://example.com",
  • "event": "company.link.create",
  • "secret": "string",
  • "condition": "string",
  • "enabled": true,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve webhook

SecurityapiAuth
Request
path Parameters
webhhook_id
required
string^\d+$
Responses
200
get/3/admin/webhooks/{webhhook_id}/
Request samples 
rehive.admin.webhooks.get(
  {"id": webhookId}
).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update webhook

SecurityapiAuth
Request
path Parameters
webhhook_id
required
string^\d+$
Request Body schema:
required
url
required
string <uri>
event
required
string
  • company.link.create - Company Link Create
  • company.link.update - Company Link Update
  • currency.create - Currency Create
  • currency.update - Currency Update
  • user.create - User Create
  • user.update - User Update
  • user.password.reset - User Password Reset
  • user.password.set - User Password Set
  • user.deactivate.verify - User Deactivate Verify
  • user.request_delete.verify - User Request Delete Verify
  • user.email.verify - User Email Verify
  • user.mobile.verify - User Mobile Verify
  • email.create - Email Create
  • email.update - Email Update
  • mobile.create - Mobile Create
  • mobile.update - Mobile Update
  • address.create - Address Create
  • address.update - Address Update
  • document.create - Document Create
  • document.update - Document Update
  • bank_account.create - Bank Account Create
  • bank_account.update - Bank Account Update
  • crypto_account.create - Crypto Account Create
  • crypto_account.update - Crypto Account Update
  • account.create - Account Create
  • account.update - Account Update
  • transaction.create - Transaction Create
  • transaction.update - Transaction Update
  • transaction.initiate - Transaction Initiate
  • transaction.execute - Transaction Execute
  • transaction.transition.create - Transaction Transition Create
  • transaction.transition.update - Transaction Transition Update
  • mfa.sms.verify - Mfa Sms Verify
Enum: "company.link.create" "company.link.update" "currency.create" "currency.update" "user.create" "user.update" "user.password.reset" "user.password.set" "user.deactivate.verify" "user.request_delete.verify" "user.email.verify" "user.mobile.verify" "email.create" "email.update" "mobile.create" "mobile.update" "address.create" "address.update" "document.create" "document.update" "bank_account.create" "bank_account.update" "crypto_account.create" "crypto_account.update" "account.create" "account.update" "transaction.create" "transaction.update" "transaction.initiate" "transaction.execute" "transaction.transition.create" "transaction.transition.update" "mfa.sms.verify"
secret
string <= 250 characters
condition
string or null <= 250 characters
enabled
boolean
archived
boolean
Default: false
Responses
200
put/3/admin/webhooks/{webhhook_id}/
Request samples
{
  • "url": "http://example.com",
  • "event": "company.link.create",
  • "secret": "string",
  • "condition": "string",
  • "enabled": true,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update webhook

SecurityapiAuth
Request
path Parameters
webhhook_id
required
string^\d+$
Request Body schema:
url
string <uri>
event
string
  • company.link.create - Company Link Create
  • company.link.update - Company Link Update
  • currency.create - Currency Create
  • currency.update - Currency Update
  • user.create - User Create
  • user.update - User Update
  • user.password.reset - User Password Reset
  • user.password.set - User Password Set
  • user.deactivate.verify - User Deactivate Verify
  • user.request_delete.verify - User Request Delete Verify
  • user.email.verify - User Email Verify
  • user.mobile.verify - User Mobile Verify
  • email.create - Email Create
  • email.update - Email Update
  • mobile.create - Mobile Create
  • mobile.update - Mobile Update
  • address.create - Address Create
  • address.update - Address Update
  • document.create - Document Create
  • document.update - Document Update
  • bank_account.create - Bank Account Create
  • bank_account.update - Bank Account Update
  • crypto_account.create - Crypto Account Create
  • crypto_account.update - Crypto Account Update
  • account.create - Account Create
  • account.update - Account Update
  • transaction.create - Transaction Create
  • transaction.update - Transaction Update
  • transaction.initiate - Transaction Initiate
  • transaction.execute - Transaction Execute
  • transaction.transition.create - Transaction Transition Create
  • transaction.transition.update - Transaction Transition Update
  • mfa.sms.verify - Mfa Sms Verify
Enum: "company.link.create" "company.link.update" "currency.create" "currency.update" "user.create" "user.update" "user.password.reset" "user.password.set" "user.deactivate.verify" "user.request_delete.verify" "user.email.verify" "user.mobile.verify" "email.create" "email.update" "mobile.create" "mobile.update" "address.create" "address.update" "document.create" "document.update" "bank_account.create" "bank_account.update" "crypto_account.create" "crypto_account.update" "account.create" "account.update" "transaction.create" "transaction.update" "transaction.initiate" "transaction.execute" "transaction.transition.create" "transaction.transition.update" "mfa.sms.verify"
secret
string <= 250 characters
condition
string or null <= 250 characters
enabled
boolean
archived
boolean
Default: false
Responses
200
patch/3/admin/webhooks/{webhhook_id}/
Request samples
{
  • "url": "http://example.com",
  • "event": "company.link.create",
  • "secret": "string",
  • "condition": "string",
  • "enabled": true,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete webhook

SecurityapiAuth
Request
path Parameters
webhhook_id
required
string^\d+$
Responses
200
delete/3/admin/webhooks/{webhhook_id}/
Request samples 
rehive.admin.webhooks.delete(
 webhookId
).then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "sucess"
}