Shopfront Developers

Webhooks

Mutation

activateWebhook — Returns Webhook

Scopes Required: edit_webhooks

Arguments Type Description

id

ID!

The ID of the webhook to activate
Example Mutation
mutation ActivateWebhook($id: ID!) {
    activateWebhook(id: $id) {
        id,
        name,
        active,
        url,
        events
    }
}

# Example variables
{
    "id": "<ID>"
}

Mutation

deactivateWebhook — Returns Webhook

Scopes Required: edit_webhooks

Arguments Type Description

id

ID!

The ID of the webhook to deactivate
Example Mutation
mutation DeactivateWebhook($id: ID!) {
    deactivateWebhook(id: $id) {
        id,
        name,
        active,
        url,
        events
    }
}

# Example variables
{
    "id": "<ID>"
}

Mutation

regenerateWebhookSignature — Returns Webhook

Scopes Required: edit_webhooks

Arguments Type Description

id

ID!

The ID of the webhook to regenerate the signature of
Example Mutation
mutation RegenerateWebhookSignature($id: ID!) {
    regenerateWebhookSignature(id: $id) {
        id,
        name,
        active,
        url,
        events
    }
}

# Example variables
{
    "id": "<ID>"
}

Mutation

registerWebhook — Returns Webhook

Scopes Required: create_webhooks

Arguments Type Description

name

String!

The name of the webhook

url

String!

The URL to call when an event is fired

events

[WebhookEventEnum!]

The events for this webhook to listen to
Example Mutation
mutation RegisterWebhook($name: String!, $url: String!) {
    registerWebhook(name: $name, url: $url) {
        id,
        name,
        active,
        url,
        events
    }
}

# Example variables
{
    "name": "<NAME>",
    "url": "<URL>"
}

Mutation

removeWebhook — Returns Webhook

Scopes Required: delete_webhooks

Arguments Type Description

id

ID!

The ID of the webhook to remove
Example Mutation
mutation RemoveWebhook($id: ID!) {
    removeWebhook(id: $id) {
        id,
        name,
        active,
        url,
        events
    }
}

# Example variables
{
    "id": "<ID>"
}