Generic Messenger APIs
Overview
This API has been available since 1.26.0
The following APIs are provided to manage Generic Messengers.
Operations
Create the Generic Messenger
Request
URI
URI
{messengerId}The type in the request JSON is used to determine that you are creating the Generic Messenger.
Request Parameters
The Id to use for the new Messenger. If not specified a secure random UUID will be generated.
Request Body
The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
An object that can hold any information about the Messenger that should be persisted.
If debug is enabled, an event log is created to assist in debugging messenger errors.
An object that can hold HTTPHeader key and value pairs.
The basic authentication password to use for requests to the Messenger.
The basic authentication username to use for requests to the Messenger.
The unique Messenger name.
The read timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests.
This field must be set to Generic.
The fully qualified URL of the endpoint that will accept requests from FusionAuth.
Example Generic Messenger Request JSON
{
"messenger": {
"connectTimeout": 1000,
"data": {
"foo": "bar"
},
"debug": false,
"headers": {
"Content-Type": "application/json"
},
"httpAuthenticationPassword": "password",
"httpAuthenticationUsername": "user-login",
"name": "Generic Messenger",
"readTimeout": 1000,
"sslCertificate": "e31e242b-4eca-4309-921f-48cb72ec9bfb",
"type": "Generic",
"url": "https://www.example.com/webhook"
}
}Response
Response Codes| Code | Description |
|---|---|
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body
The connect timeout for the HTTP connection, in milliseconds.
An object that can hold any information about the Messenger that should be persisted.
If debug is enabled, an event log is created to assist in debugging messenger errors.
An object that can hold HTTPHeader key and value pairs.
The basic authentication password to use for requests to the Messenger.
The basic authentication username to use for requests to the Messenger.
The unique Id of the Messenger.
The instant when the Messenger was created.
The instant when the Messenger was last updated.
The unique Messenger name.
The read timeout for the HTTP connection, in milliseconds.
The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests to the Messenger.
The message transport protocol used to send a message. This value is currently read-only and set to sms.
This field will always be Generic.
The fully qualified URL of the endpoint that will accept requests from FusionAuth.
Example Generic Messenger Response JSON
{
"messenger": {
"connectTimeout": 1000,
"data": {
"foo": "bar"
},
"debug": false,
"headers": {
"Content-Type": "application/json"
},
"httpAuthenticationPassword": "password",
"httpAuthenticationUsername": "user-login",
"id": "2d5acca6-23d5-423f-ac7b-b70f50b54498",
"insertInstant": 1562189072183,
"lastUpdateInstant": 1562189072183,
"name": "Generic Messenger",
"readTimeout": 1000,
"sslCertificate": "e31e242b-4eca-4309-921f-48cb72ec9bfb",
"transport": "sms",
"type": "Generic",
"url": "https://www.example.com/webhook"
}
}Retrieve the Generic Messenger
Request
URI
{messengerId}Request Parameters
The Id of the Messenger to retrieve.
Response
| Code | Description |
|---|---|
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
| 404 | The object you requested doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body
The connect timeout for the HTTP connection, in milliseconds.
An object that can hold any information about the Messenger that should be persisted.
If debug is enabled, an event log is created to assist in debugging messenger errors.
An object that can hold HTTPHeader key and value pairs.
The basic authentication password to use for requests to the Messenger.
The basic authentication username to use for requests to the Messenger.
The unique Id of the Messenger.
The instant when the Messenger was created.
The instant when the Messenger was last updated.
The unique Messenger name.
The read timeout for the HTTP connection, in milliseconds.
The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests to the Messenger.
The message transport protocol used to send a message. This value is currently read-only and set to sms.
This field will always be Generic.
The fully qualified URL of the endpoint that will accept requests from FusionAuth.
Example Generic Messenger Response JSON
{
"messenger": {
"connectTimeout": 1000,
"data": {
"foo": "bar"
},
"debug": false,
"headers": {
"Content-Type": "application/json"
},
"httpAuthenticationPassword": "password",
"httpAuthenticationUsername": "user-login",
"id": "2d5acca6-23d5-423f-ac7b-b70f50b54498",
"insertInstant": 1562189072183,
"lastUpdateInstant": 1562189072183,
"name": "Generic Messenger",
"readTimeout": 1000,
"sslCertificate": "e31e242b-4eca-4309-921f-48cb72ec9bfb",
"transport": "sms",
"type": "Generic",
"url": "https://www.example.com/webhook"
}
}Update the Generic Messenger
This API is used to update an existing Generic Messenger.
You must specify all of the properties of the Generic Messenger when calling this API with the PUT HTTP method. When used with PUT, this API doesn’t merge the existing Generic Messenger and your new data. It replaces the existing Generic Messenger with your new data.
Utilize the PATCH HTTP method to send specific changes to merge into an existing Generic Messenger.
Request
URI
{messengerId}URI
{messengerId}Available since 1.39.0
When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902] or JSON Merge Patch/RFC 7396. See the PATCH documentation for more information.
Available since 1.12.0
When using the PATCH method, use the same request body documentation that is provided for the PUT request.
The PATCH method will merge the provided request parameters into the existing object, this means all parameters are optional when using the PATCH method and you only provide the values you want changed.
A null value can be used to remove a value.
Patching an Array will result in all values from the new list being appended to the existing list, this is a known limitation to the current implementation of PATCH.
Request Parameters
The Id of the Messenger to update.
Request Body
The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
An object that can hold any information about the Messenger that should be persisted.
If debug is enabled, an event log is created to assist in debugging messenger errors.
An object that can hold HTTPHeader key and value pairs.
The basic authentication password to use for requests to the Messenger.
The basic authentication username to use for requests to the Messenger.
The unique Messenger name.
The read timeout for the HTTP connection, in milliseconds. Value must be greater than 0.
The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests.
This field must be set to Generic.
The fully qualified URL of the endpoint that will accept requests from FusionAuth.
Example Generic Messenger Request JSON
{
"messenger": {
"connectTimeout": 1000,
"data": {
"foo": "bar"
},
"debug": false,
"headers": {
"Content-Type": "application/json"
},
"httpAuthenticationPassword": "password",
"httpAuthenticationUsername": "user-login",
"name": "Generic Messenger",
"readTimeout": 1000,
"sslCertificate": "e31e242b-4eca-4309-921f-48cb72ec9bfb",
"type": "Generic",
"url": "https://www.example.com/webhook"
}
}Response
The response for this API contains the Generic Messenger.
| Code | Description |
|---|---|
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
| 404 | The object you are trying to update doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body
The connect timeout for the HTTP connection, in milliseconds.
An object that can hold any information about the Messenger that should be persisted.
If debug is enabled, an event log is created to assist in debugging messenger errors.
An object that can hold HTTPHeader key and value pairs.
The basic authentication password to use for requests to the Messenger.
The basic authentication username to use for requests to the Messenger.
The unique Id of the Messenger.
The instant when the Messenger was created.
The instant when the Messenger was last updated.
The unique Messenger name.
The read timeout for the HTTP connection, in milliseconds.
The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests to the Messenger.
The message transport protocol used to send a message. This value is currently read-only and set to sms.
This field will always be Generic.
The fully qualified URL of the endpoint that will accept requests from FusionAuth.
Example Generic Messenger Response JSON
{
"messenger": {
"connectTimeout": 1000,
"data": {
"foo": "bar"
},
"debug": false,
"headers": {
"Content-Type": "application/json"
},
"httpAuthenticationPassword": "password",
"httpAuthenticationUsername": "user-login",
"id": "2d5acca6-23d5-423f-ac7b-b70f50b54498",
"insertInstant": 1562189072183,
"lastUpdateInstant": 1562189072183,
"name": "Generic Messenger",
"readTimeout": 1000,
"sslCertificate": "e31e242b-4eca-4309-921f-48cb72ec9bfb",
"transport": "sms",
"type": "Generic",
"url": "https://www.example.com/webhook"
}
}Delete the Generic Messenger
Request
URI
{messengerId}The Id of the Messenger to delete.
Response
This API does not return a JSON response body.
| Code | Description |
|---|---|
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
| 404 | The object you requested doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |