Webhook that can be connected to.

You can configure access to the webhook using this function.

webhook : Webhook
webhook =
    toWebhook
        "https://example.com"
        "your-secret-api-key"
        "!abcdef:example.org"

Send a message to the webhook. The message supports Markdown.

sendMessage : Cmd msg
sendMessage toMsg webhook "hi mom!"

It is recommended to use this function to make a smaller one and focus on sending the messages.

send : String -> Cmd msg
send = sendMessage toMsg webhook


-- These all send a message to the Matrix-Webhook API
send "hi mom!"
send "I am a **big** adult now."
send "Are you proud of me? :)"

The previous message is all nicely set up, but some people prefer a simple function where you can insert all your data right away. This function is relatively careless, allowing you to send message to the Webhook API and only getting a Bool in return that lets you know whether the message was sent successfully.

type Msg = Success Bool


sendRaw
    Success
    "https://example.com"
    "your-secret-api-key"
    "!abcdef:example.org"
    "hi mom!"
== sendMessage toMsg webhook "hi mom!"

Note: If the function returns False, there is no way of finding out why it went wrong.

Sometimes the webhook request fails, and you'd like to know why. The error type explains more about why a request may have failed:

• BadUrl means the provided url was formed badly.
• HomeserverReturnedError means the homeserver refuses to send the message, returning a status code and an error message.
• HomeserverTimeoutError means the homeserver takes too long to respond to the webhook.
• NetworkError means that something went wrong with the connection. The user may have entered a cave or shut off their WiFi.
• NotJoinedToRoom means that the user is not part of the room and that the webhook is unable to join the room.
• Unauthorized means that an invalid Webhook API key was provided.
• WebhookMissingInput means that the Webhook API requires an unknown input. This may happen if a future version requires a certain value that the API does not specify yet.
• WebhookReturnedInvalidJSON means that the Webhook API returned invalid or unexpected JSON objects.
• WehookTimeoutError means that the Webhook API takes too long to respond.