Create ModHeader embedded button

The ModHeader button is a small button displayed on your website to help viewers easily import your data into ModHeader. A ModHeader button consists on a small iframe HTML markup that you may copy-and-paste into your website template.

If ModHeader is already installed on the viewer's browser, then this button will allow the viewer to import into ModHeader directly. Otherwise, it will guide the viewer to download ModHeader from the appropriate extension store for their browser.

How to add a ModHeader button to your website

1, Create the embedded button HTML tag using one of the following options:

  • Option 1: The easiest way to create an embedded ModHeader button is to open the ModHeader extension, then click on the Export button to open up the export dialog. Select Embedded button tab, and copy the iframe tag generated there.

  • Option 2: Use this tool below to create a simple iframe tag to import a list of request headers, then copy-and-paste that into your website. If you have a more complicated profile, you can also use the Export dialog in ModHeader to create an embedded button based on that profile.

Tags:
<iframe src="https://modheader.com/embed/modheader" frameborder="0" width="180px" height="40px" title="Import to ModHeader"></iframe>
  • Option 3: Follow the Embedded URL specs docs below to create your custom embedded URL. This is most useful if you need to generate the Embedded URL programmatically.

2, Copy-and-paste the HTML tag into your website HTML where you want the button to appear.

Embedded URL specs

The embedded URL for ModHeader is https://modheader.com/embed/modheader, and accept the one of the following URL parameters:

  • profile_id: UUID of the exported profile. For example, if your exported profile URL is https://modheader.com/profile/{{uuid}}, then {{uuid}} is the profile ID, and you can use https://modheader.com/embed/modheader?profile_id={{uuid}} to create the embedded button for that profile.

  • profile: JSON encoded ModHeader profile. You can also obtain this from the ModHeader export dialog. Make sure to URL encode this string so the data is passed in correctly.

  • req-{{header_name}}: Simple way of creating an embedded button for importing one or more request headers. For example, if you would like to import the headers foo: bar, and hello: world, the you can do: https://modheader.com/embed/modheader?req-foo=bar&req-hello=world. Make sure to URL encode the values so that the data is passed in correctly.

Embedded URL for ModResponse

The embedded URL for ModResponse very similar to that of ModHeader embedded URL above, with the following exceptions:

  • The embedded URL prefix is https://modheader.com/embed/modresponse
  • The req-{{header_name}} URL parameter is not supported.