How to Webhooks usage

Benjamin

Romhack Plaza's webhooks let you stay up to date in real time on new content and updates to entries on the site. This can be useful for your personal website or your projects.

How do I sign up for this service?

First, you must have an account on the site. Next, in the Settings menu on the top bar, you'll find “Webhooks Subscriptions.”

This will take you to a page where you can manage your current subscriptions or add new ones.

When you create a subscription, you must specify the URL where the subscription information will be sent. You can also enter a name and choose the scope of your subscription.

For scopes, you can choose by type, a specific entry, or even your own entries.

Once you’ve created your subscription, you’ll receive a secret that will allow you to verify any information transmitted.

How to Use Webhooks

You must set up a system to verify and process the data that is sent.

To verify the data, you must perform the following operation:
Calculate the SHA-256 hash of the response/payload using the secret, then construct the following string:

‘sha256=<HASH>’

And you must verify that this string matches the one in the ‘X-Webhook-Signature’ header.

If you’re using PHP, here’s a sample code snippet:

PHP:

function romhackPlaza_VerifyWebhookSignature(
    string $X_Webhook_Signature,
    string $payload,
    string $secret
): bool
{
    $expected = 'sha256=' . hash_hmac('sha256', $payload, $secret);
    return hash_equals($expected, $X_Webhook_Signature);
}

The transmitted information will be in this format:

JSON:

[
    'action': 'published,version-updated',
    'entry_id': 0,
    'entry_title': "",
    'entry_version': "",
    'entry' => Entry (More details on getEntry API Endpoint)
]

What are the limitations of webhooks?

Three attempts will be made if your first request fails. After that, the information will no longer be sent. If we see that a webhook with an invalid URL has not been deactivated, the webhook will be suspended.

If you haven’t financially supported Romhack Plaza, you’re limited to two separate webhooks. To get more webhooks, we invite you to support Romhack Plaza; more information is available on the webhook management page.
Additionally, you don’t have access to the “any” scope, which covers all entries.

Any use of multiple accounts to circumvent this limit may result in a permanent ban of your accounts, as well as the removal of all your content from the site.

If you have any questions about the API, please post your questions below the documentation.

How to Webhooks usage

API Documentation