Use webhooks to receive instant notifications about events happening in Lokalise as POST requests. 

The webhook is sent just once as the event happens and it does not expect any answers from your side. We do not sign the requests, so you may want to restrict the incoming requsts from IP's 88.99.69.168, 138.201.23.91 and 94.130.129.237.

To set up the integration for your project:

  1. Navigate to project settings > Integrations
  2. Click Connect at the required integration
  3. Enter configuration parameters
  4. Select desired events
  5. Click Enable integration

Webhook payload examples

{
    "event": "translation.updated",
    "created_at": "2017-12-13 14:08:32",
    "created_at_timestamp": 1513174112,
    "data": {
        "translation": "Getting packages.",
        "lang": {
            "name": "English",
            "iso": "en"
        },
        "key": {
            "id": "6949307",
            "key": "index.packages"
        },
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "translation.proofread",
    "created_at": "2017-12-13 14:08:46",
    "created_at_timestamp": 1513174126,
    "data": {
        "translation": "You already have an authorised number.",
        "is_proofread": 1,
        "lang": {
            "name": "English",
            "iso": "en"
        },
        "key": {
            "id": "6949305",
            "key": "index.already"
        },
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "project.import",
    "created_at": "2017-12-13 14:10:50",
    "created_at_timestamp": 1513174250,
    "data": {
        "filename": "strings.xml",
        "format": "XML",
        "inserted": 1,
        "skipped": 719,
        "updated": 0,
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "project.export",
    "created_at": "2017-12-13 14:17:41",
    "created_at_timestamp": 1513174661,
    "data": {
        "bundle_filename": "files/export/121034185a1bfae435ac49.76856749/1513174659/My_SuperApp-Localizable.zip",
        "type": "strings",
        "platform": "iOS",
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "key.added",
    "created_at": "2017-12-13 14:18:07",
    "created_at_timestamp": 1513174687,
    "data": {
        "key": "app.index.content",
        "key_id": 12345,
        "base_value": "Welcome to MyApp!",
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "key.deleted",
    "created_at": "2017-12-13 14:18:25",
    "created_at_timestamp": 1513174705,
    "data": {
        "key_names": "index.title",
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "key.modified",
    "created_at": "2017-12-13 14:19:00",
    "created_at_timestamp": 1513174740,
    "data": {
        "key": "contacts_tab_all",
        "key_id": 12345,
        "previous_key": "contactList",
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "key.commented",
    "created_at": "2017-12-13 14:19:30",
    "created_at_timestamp": 1513174770,
    "data": {
        "key": "settings_local_sim_status_not_linked",
        "comment": "Shown when SIM is not linked.",
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "language.added",
    "created_at": "2017-12-13 14:19:57",
    "created_at_timestamp": 1513174797,
    "data": {
        "langs": [
            {
                "lang_iso": "es_CO",
                "lang_name": "Spanish (Colombia)",
                "lang_id": "647"
            }
        ],
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "language.removed",
    "created_at": "2017-12-13 14:20:16",
    "created_at_timestamp": 1513174816,
    "data": {
        "lang_iso": "lt_LT",
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "language.settings_changed",
    "created_at": "2017-12-13 14:38:34",
    "created_at_timestamp": 1513175914,
    "data": {
        "lang_iso": "es_ES",
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "contributor.added",
    "created_at": "2017-12-13 14:39:10",
    "created_at_timestamp": 1513175950,
    "data": {
        "email": "petr@lokalise.co",
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
{
    "event": "contributor.removed",
    "created_at": "2017-12-13 14:41:29",
    "created_at_timestamp": 1513176089,
    "data": {
        "email": "petr@lokalise.co",
        "project": {
            "id": "121034185a1bfae435ac49.76856749",
            "name": "My SuperApp"
        },
        "user": {
            "fullname": "John Matthews",
            "email": "john@lokalise.co"
        }
    }
}
Did this answer your question?