This API method is used to create webhook URLs. Screenshot for reference.
Parameter | Required | Type | Description |
---|---|---|---|
apikey | yes | string | Your authorized API key |
secret | yes | string | Your authorized secret key |
user_id | yes | string | Unique Id for user |
business_id | yes | string | Unique Id for workspace |
setup | yes | string | Set the value as "webhook" |
webhook_url | yes | string | The URL which has to be created as the webhook URL |
{ "status": "success", "status_code": 200, "message": "Your webhook url has been created successfully", "result": { "webhook_url": URL, "business_id": "xxxxxxxxxxxxxxxxxxx" } }
Error Code | Description |
---|---|
701 | User id parameter required |
702 | User id is required |
701 | Business id parameter required |
702 | Business id required |
610 | Invalid user id |
610 | Invalid business id |
613 | Invalid user and business |
702 | Tags, contact id or phone number is required |
720 | Invalid Phone Number |
{ "error": { "reason": "parameter missing", "message": "User id parameter required", "field_name": "user_id", "code": 701, "error_type": "missing_parameter" } }
{ "error": { "reason": "required field", "message": "User id is required", "code": 702, "error_type": "required" } }
{ "error": { "reason": "parameter missing", "message": "Business id parameter required", "field_name": "business_id", "code": 701, "error_type": "missing_parameter" } }
{ "error": { "reason": "required field", "message": "Business id required", "code": 702, "error_type": "required" } }
{ "error": { "errors": [ { "reason": "Invalid Id", "message": "Please make sure you have provided the valid user id" } ], "code": 610, "error_type": "reference_error" } }
{ "error": { "errors": [ { "reason": "Invalid Id", "message": "Please make sure you have provided the valid business id" } ], "code": 610, "error_type": "reference_error" } }
{ "error": { "errors": [ { "reason": "Invalid user and business", "message": "The business and user id combination that you provided doesn't match in our record" } ], "code": 613, "error_type": "invalid_user_business" } }
{ "error": { "errors": [ { "reason": "required field", "message": "Tag name required" } ], "code": 702, "error_type": "required" } }
{ "error": { "errors": [ { "reason": "Invalid Phone", "message": "A valid phone number is required." } ], "code": 720, "error_type": "invalid_phone_number", "number_format": "+1-415123456" } }
Loading please wait...