Generic Messenger API

Edit on GitHubView Markdown
On this page
Available since 1.26.0

The following APIs are provided to manage Generic Messengers.

Create the Generic Messenger#

Request#

Global API Key Authentication
Create a Generic Messenger with a randomly generated Id.
POST/api/messenger
OpenAPI Spec
Global API Key Authentication
Create a Generic Messenger with the provided unique Id.
POST/api/messenger/{messengerId}
OpenAPI Spec

The type in the request JSON is used to determine that you are creating the Generic Messenger.

Request Parameters#

messengerId
  • Type: UUID
  • Optional
  • Defaults to secure random UUID

The Id to use for the new Messenger. If not specified a secure random UUID will be generated.

Request Body#

messenger.connectTimeout
  • Type: Integer
  • Required

The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

messenger.data
  • Type: Object
  • Optional

An object that can hold any information about the Messenger that should be persisted.

messenger.debug
  • Type: Boolean
  • Optional
  • Defaults to false

If debug is enabled, an event log is created to assist in debugging messenger errors.

messenger.headers
  • Type: Object
  • Optional

An object that can hold HTTPHeader key and value pairs.

messenger.httpAuthenticationPassword
  • Type: String
  • Optional

The basic authentication password to use for requests to the Messenger.

messenger.httpAuthenticationUsername
  • Type: String
  • Optional

The basic authentication username to use for requests to the Messenger.

messenger.messageTypes
  • Type: Array<String>
  • Optional
  • Defaults to ["SMS"]
  • Available since 1.65.0

The set of message types this messenger can send.

Supported values include:

  • SMS
  • Voice
messenger.name
  • Type: String
  • Required

The unique Messenger name.

messenger.readTimeout
  • Type: Integer
  • Required

The read timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

messenger.sslCertificateId
  • Type: UUID
  • Optional

The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests.

messenger.type
  • Type: String
  • Required

This field must be set to Generic.

messenger.url
  • Type: String
  • Required

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",
    "messageTypes": [
      "SMS",
      "Voice"
    ],
    "name": "Generic Messenger",
    "readTimeout": 1000,
    "sslCertificate": "e31e242b-4eca-4309-921f-48cb72ec9bfb",
    "type": "Generic",
    "url": "https://www.example.com/webhook"
  }
}

Response#

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The 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.
401You 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.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

messenger.connectTimeout
  • Type: Integer

The connect timeout for the HTTP connection, in milliseconds.

messenger.data
  • Type: Object

An object that can hold any information about the Messenger that should be persisted.

messenger.debug
  • Type: Boolean

If debug is enabled, an event log is created to assist in debugging messenger errors.

messenger.headers
  • Type: Object

An object that can hold HTTPHeader key and value pairs.

messenger.httpAuthenticationPassword
  • Type: String

The basic authentication password to use for requests to the Messenger.

messenger.httpAuthenticationUsername
  • Type: String

The basic authentication username to use for requests to the Messenger.

messenger.id
  • Type: UUID

The unique Id of the Messenger.

messenger.insertInstant
  • Type: Long

The instant when the Messenger was created.

messenger.lastUpdateInstant
  • Type: Long

The instant when the Messenger was last updated.

messenger.messageTypes
  • Type: Array<String>
  • Available since 1.65.0

The set of message types this messenger can send.

messenger.name
  • Type: String

The unique Messenger name.

messenger.readTimeout
  • Type: Integer

The read timeout for the HTTP connection, in milliseconds.

messenger.sslCertificateId
  • Type: UUID

The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests to the Messenger.

messenger.transport
  • Type: String
  • Available since 1.26.0

Deprecated. This legacy field remains for backward compatibility. Use messenger.messageTypes instead.

messenger.type
  • Type: String

This field will always be Generic.

messenger.url
  • Type: String

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,
    "messageTypes": [
      "SMS",
      "Voice"
    ],
    "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#

Global API Key Authentication
Retrieve the Generic Messenger by Id
GET/api/messenger/{messengerId}
OpenAPI Spec

Request Parameters#

messengerId
  • Type: UUID
  • Required

The Id of the Messenger to retrieve.

Response#

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The 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.
401You 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.
404The object you requested doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

messenger.connectTimeout
  • Type: Integer

The connect timeout for the HTTP connection, in milliseconds.

messenger.data
  • Type: Object

An object that can hold any information about the Messenger that should be persisted.

messenger.debug
  • Type: Boolean

If debug is enabled, an event log is created to assist in debugging messenger errors.

messenger.headers
  • Type: Object

An object that can hold HTTPHeader key and value pairs.

messenger.httpAuthenticationPassword
  • Type: String

The basic authentication password to use for requests to the Messenger.

messenger.httpAuthenticationUsername
  • Type: String

The basic authentication username to use for requests to the Messenger.

messenger.id
  • Type: UUID

The unique Id of the Messenger.

messenger.insertInstant
  • Type: Long

The instant when the Messenger was created.

messenger.lastUpdateInstant
  • Type: Long

The instant when the Messenger was last updated.

messenger.messageTypes
  • Type: Array<String>
  • Available since 1.65.0

The set of message types this messenger can send.

messenger.name
  • Type: String

The unique Messenger name.

messenger.readTimeout
  • Type: Integer

The read timeout for the HTTP connection, in milliseconds.

messenger.sslCertificateId
  • Type: UUID

The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests to the Messenger.

messenger.transport
  • Type: String
  • Available since 1.26.0

Deprecated. This legacy field remains for backward compatibility. Use messenger.messageTypes instead.

messenger.type
  • Type: String

This field will always be Generic.

messenger.url
  • Type: String

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,
    "messageTypes": [
      "SMS",
      "Voice"
    ],
    "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#

Global API Key Authentication
Update the Generic Messenger by Id
PUT/api/messenger/{messengerId}
OpenAPI Spec
PATCH/api/messenger/{messengerId}
OpenAPI Spec
Note

For backward compatibility, the PATCH method accepts the same media type (specified by a Content-Type of application/json) and body as the PUT request. You can also use the following media types for different behavior:

For details, see the PATCH documentation.

Using a media type of application/json merges the provided request parameters into the existing object. As a result, all parameters are optional with PATCH: only provide the values you want to change. To remove a value, provide a null value. Patching an Array appends all values in the new list to the old list.

Request Parameters#

messengerId
  • Type: UUID
  • Required

The Id of the Messenger to update.

Request Body#

messenger.connectTimeout
  • Type: Integer
  • Required

The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

messenger.data
  • Type: Object
  • Optional

An object that can hold any information about the Messenger that should be persisted.

messenger.debug
  • Type: Boolean
  • Optional
  • Defaults to false

If debug is enabled, an event log is created to assist in debugging messenger errors.

messenger.headers
  • Type: Object
  • Optional

An object that can hold HTTPHeader key and value pairs.

messenger.httpAuthenticationPassword
  • Type: String
  • Optional

The basic authentication password to use for requests to the Messenger.

messenger.httpAuthenticationUsername
  • Type: String
  • Optional

The basic authentication username to use for requests to the Messenger.

messenger.messageTypes
  • Type: Array<String>
  • Optional
  • Defaults to ["SMS"]
  • Available since 1.65.0

The set of message types this messenger can send.

Supported values include:

  • SMS
  • Voice
messenger.name
  • Type: String
  • Required

The unique Messenger name.

messenger.readTimeout
  • Type: Integer
  • Required

The read timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

messenger.sslCertificateId
  • Type: UUID
  • Optional

The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests.

messenger.type
  • Type: String
  • Required

This field must be set to Generic.

messenger.url
  • Type: String
  • Required

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",
    "messageTypes": [
      "SMS",
      "Voice"
    ],
    "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.

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The 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.
401You 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.
404The object you are trying to update doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body#

messenger.connectTimeout
  • Type: Integer

The connect timeout for the HTTP connection, in milliseconds.

messenger.data
  • Type: Object

An object that can hold any information about the Messenger that should be persisted.

messenger.debug
  • Type: Boolean

If debug is enabled, an event log is created to assist in debugging messenger errors.

messenger.headers
  • Type: Object

An object that can hold HTTPHeader key and value pairs.

messenger.httpAuthenticationPassword
  • Type: String

The basic authentication password to use for requests to the Messenger.

messenger.httpAuthenticationUsername
  • Type: String

The basic authentication username to use for requests to the Messenger.

messenger.id
  • Type: UUID

The unique Id of the Messenger.

messenger.insertInstant
  • Type: Long

The instant when the Messenger was created.

messenger.lastUpdateInstant
  • Type: Long

The instant when the Messenger was last updated.

messenger.messageTypes
  • Type: Array<String>
  • Available since 1.65.0

The set of message types this messenger can send.

messenger.name
  • Type: String

The unique Messenger name.

messenger.readTimeout
  • Type: Integer

The read timeout for the HTTP connection, in milliseconds.

messenger.sslCertificateId
  • Type: UUID

The Id of an existing Key. The X.509 certificate is used for client certificate authentication in requests to the Messenger.

messenger.transport
  • Type: String
  • Available since 1.26.0

Deprecated. This legacy field remains for backward compatibility. Use messenger.messageTypes instead.

messenger.type
  • Type: String

This field will always be Generic.

messenger.url
  • Type: String

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,
    "messageTypes": [
      "SMS",
      "Voice"
    ],
    "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#

Global API Key Authentication
Delete the Generic Messenger by Id
DELETE/api/messenger/{messengerId}
OpenAPI Spec
messengerId
  • Type: UUID
  • Required

The Id of the Messenger to delete.

Response#

This API does not return a JSON response body.

Response Codes
CodeDescription
200The request was successful.
400The 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.
401You 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.
404The object you requested doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Related

APIs

Twilio Messenger API

Learn about the APIs for creating, retrieving, and updating Twilio Messengers.

fusionauth apirest apihttp api
APIs

Messenger API

Learn about the APIs for creating, retrieving, updating and deleting messengers.

fusionauth apirest apihttp api
APIs

User Action API

Learn about the APIs for invoking a User Action on a User.

fusionauth apirest apihttp api
APIs

Create an API Key API

API documentation for the FusionAuth Create an API Key API.

fusionauth apirest apihttp api